Remove # doctest: (#260)

pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "coola"
-version = "0.0.23a3"
+version = "0.0.23a4"
 description = "A library to check if two complex/nested objects are equal or not"
 readme = "README.md"
 authors = ["Thibaut Durand <durand.tibo+gh@gmail.com>"]

src/coola/reducers/base.py

@@ -194,7 +194,7 @@ def std(self, values: Sequence[int | float]) -> float:
 
             >>> from coola.reducers import TorchReducer
             >>> reducer = TorchReducer()
-            >>> reducer.std([-2, -1, 0, 1, 2])  # doctest: +ELLIPSIS
+            >>> reducer.std([-2, -1, 0, 1, 2])
             1.581138...
         """
 

src/coola/reducers/registry.py

@@ -63,7 +63,7 @@ def available_reducers(cls) -> tuple[str, ...]:
         .. code-block:: pycon
 
             >>> from coola.reducers import ReducerRegistry
-            >>> ReducerRegistry.available_reducers()  # doctest: +ELLIPSIS
+            >>> ReducerRegistry.available_reducers()
             (...)
         """
         return tuple(cls.registry.keys())

src/coola/reduction.py

@@ -25,7 +25,7 @@ def available_reducers(cls) -> tuple[str, ...]:
         .. code-block:: pycon
 
             >>> from coola import Reduction
-            >>> Reduction.available_reducers()  # doctest: +ELLIPSIS
+            >>> Reduction.available_reducers()
             (...)
         """
         return ReducerRegistry.available_reducers()

src/coola/summarizers/summarizer.py

@@ -189,7 +189,7 @@ def state_dict(cls) -> dict:
         .. code-block:: pycon
 
             >>> from coola import Summarizer
-            >>> Summarizer.state_dict()  # doctest: +ELLIPSIS
+            >>> Summarizer.state_dict()
             {<class 'collections.abc.Mapping'>: {'max_items': 5, 'num_spaces': 2},...
         """
         return {data_type: formatter.state_dict() for data_type, formatter in cls.registry.items()}

src/coola/testers/allclose.py

@@ -205,7 +205,7 @@ def local_copy(cls) -> LocalAllCloseTester:
         .. code-block:: pycon
 
             >>> from coola.testers import AllCloseTester
-            >>> AllCloseTester.local_copy()  # doctest: +ELLIPSIS
+            >>> AllCloseTester.local_copy()
             LocalAllCloseTester(...)
         """
         return LocalAllCloseTester({key: value.clone() for key, value in cls.registry.items()})

src/coola/testers/equality.py

@@ -164,7 +164,7 @@ def local_copy(cls) -> LocalEqualityTester:
 
             >>> from coola.testers import EqualityTester
             >>> tester = EqualityTester.local_copy()
-            >>> tester  # doctest: +ELLIPSIS
+            >>> tester
             LocalEqualityTester(...)
         """
         return LocalEqualityTester({key: value.clone() for key, value in cls.registry.items()})

src/coola/utils/tensor.py

@@ -24,7 +24,7 @@ def get_available_devices() -> tuple[str, ...]:
     .. code-block:: pycon
 
         >>> from coola.utils.tensor import get_available_devices
-        >>> get_available_devices()  # doctest:+ELLIPSIS
+        >>> get_available_devices()
         ('cpu'...)
     """
     devices = ["cpu"]