From 3dd02edc78a24e413ef7baac9d1c10089b3be034 Mon Sep 17 00:00:00 2001
From: Adriaan de Groot <groot@kde.org>
Date: Mon, 15 Nov 2021 23:16:58 +0100
Subject: [PATCH] [libcalamares] Document how to interpret percents

- use 0..1 in floats for percentages (I suppose you could
  call that a perunage, but that would be weird).
---
 src/libcalamares/Job.h | 5 +++++
 1 file changed, 5 insertions(+)

diff --git a/src/libcalamares/Job.h b/src/libcalamares/Job.h
index 58a9bba39..33965e15f 100644
--- a/src/libcalamares/Job.h
+++ b/src/libcalamares/Job.h
@@ -132,6 +132,11 @@ public:
     void setEmergency( bool e ) { m_emergency = e; }
 
 signals:
+    /** @brief Signals that the job has made progress
+     *
+     * The parameter @p percent should be between 0 (0%) and 1 (100%).
+     * Values outside of this range will be clamped.
+     */
     void progress( qreal percent );
 
 private: