added a :param docstring to src/krux/format.py

added a docstring to tests/test_format.py
selfcustody · Jan 7, 2024 · 7f6cc74 · 7f6cc74
1 parent 82ad974
commit 7f6cc74
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 1 deletion.
diff --git a/src/krux/format.py b/src/krux/format.py
@@ -27,9 +27,12 @@
 
 
 def format_btc(amount):
-    """Formats a BTC value according to the locale and
+    """
+    Formats a BTC value according to the locale and
     the International Bureau of Weights and Measures,
     while still using the idea behind the Satcomma standard
+
+    :param amount: int
     """
 
     btc_without_decimal = amount // SATS_PER_BTC

diff --git a/tests/test_format.py b/tests/test_format.py
@@ -1,4 +1,11 @@
+# pylint: disable=unused-argument
 def test_format_btc(m5stickv):
+    """
+    Test many cases where the format of a BTC value
+    can be shown on device according :function:`krux.format.format_btc`
+
+    :param m5stickv: the device
+    """
     from krux.format import format_btc
 
     cases = [