Add basic doctest for format_number

.travis.yml

@@ -12,13 +12,13 @@ matrix:
       install:
         - pip install --upgrade pip
         - pip3 install -e .
-      script: pytest
+      script: ./test.sh
     - language: python
       python: "3.7"
       dist: xenial
       install:
         - pip install --upgrade pip
         - pip3 install -e .
       script:
-        - pytest
-        - TEMCI_TEST_CMD=1 pytest
+        - ./test.sh
+        - TEMCI_TEST_CMD=1 ./test.sh

README.rst

@@ -256,7 +256,7 @@ Install temci via `pip` and run the tests via
 
 .. code:: sh
 
-    pytest tests
+    ./test.sh
 
 The tests can be found in the `tests` folder and use the pytest framework.
 

conftest.py

@@ -0,0 +1,6 @@
+import py
+from py.path import local
+
+
+def pytest_ignore_collect(path: py.path.local):
+    return "misc" in str(path) or "/doc/" in str(path) or "library_init" in str(path) or "cli" in str(path)

doc/contributing.rst

@@ -30,10 +30,12 @@ Testing
 The tests are located in the ``tests`` folder and roughly grouped by the temci subcommand they belong to.
 New features should by covered by tests.
 
+There is also support for doctests that can be added into the documentation.
+
 The tests are using the pytest framework and can be executed by simply calling
 
 .. code:: sh
 
-    pytest
+    ./test.sh
 
 It recommended to install the package ``pytest-clarity`` to improve the error output.

temci/utils/number.py

@@ -136,22 +136,34 @@ def init_settings(cls, new_settings: t.Dict[str, t.Union[int, bool]]):
 
 def format_number(number: Number, deviation: float = 0.0,
                   parentheses: bool = True, explicit_deviation: bool = False,
-                  is_deviation_absolute: bool = False,
+                  is_deviation_absolute: bool = True,
                   min_decimal_places: int = 3,
                   max_decimal_places: t.Optional[int] = None,
                   omit_insignificant_decimal_places: bool = True,
                   scientific_notation: bool = False,
                   scientific_notation_steps: int = 3,
                   scientific_notation_decimal_places: int = None,
                   scientific_notation_si_prefixes: bool = True,
-                  force_min_decimal_places: bool = False,
+                  force_min_decimal_places: bool = True,
                   relative_to_deviation: bool = False,
                   sigmas: int = 2,
                   parentheses_mode: ParenthesesMode = ParenthesesMode.ORDER_OF_MAGNITUDE
                   ) -> str:
     """
     Format the passed number
 
+    >>> format_number(1.0, 0.5)
+    '1.(000)'
+
+    >>> format_number(1.56, 0.005)
+    '1.56(0)'
+
+    >>> format_number(1560, scientific_notation=True)
+    '1.560k'
+
+    >>> format_number(1560, scientific_notation_si_prefixes=False, scientific_notation=True)
+    '1.560e3'
+
     :param number: formatted number
     :param deviation: standard deviation associated with the number
     :param parentheses: show parentheses around non significant digits?
@@ -208,7 +220,7 @@ def _format_number(number: Number, deviation: float,
                    min_decimal_places: int = 3,
                    max_decimal_places: t.Optional[int] = None,
                    omit_insignificant_decimal_places: bool = True,
-                   force_min_decimal_places: bool = False,
+                   force_min_decimal_places: bool = True,
                    relative_to_deviation: bool = False,
                    scientific_notation: bool = False,
                    scientific_notation_si_prefixes: bool = True,

test.sh

@@ -0,0 +1,5 @@
+#! /bin/sh
+
+cd "$(dirname "$0")"
+pytest --doctest-modules --doctest-glob='*.rst'
+

tests/test_basic.py

@@ -32,3 +32,7 @@ def test_config_default_values():
             "runs": 11
         }
     }).out
+
+
+def test_format():
+    assert run_temci("format 1.001 0.05").out == "1.0(01)"