docs: use pep484 typing annotations

Bayer-Group · Aug 21, 2020 · 9ad9299 · 9ad9299
1 parent 7825717
commit 9ad9299
Show file tree

Hide file tree

Showing 3 changed files with 9 additions and 1 deletion.
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -39,6 +39,7 @@
     "sphinx.ext.viewcode",
     "sphinx.ext.napoleon",
     "sphinxemoji.sphinxemoji",
+    "sphinx_autodoc_typehints",
 ]
 
 # Add any paths that contain templates here, relative to this directory.
@@ -52,6 +53,7 @@
 
 autodoc_member_order = 'bysource'
 
+set_type_checking_flag = True
 
 # -- Options for HTML output -------------------------------------------------
 

diff --git a/paquo/hierarchy.py b/paquo/hierarchy.py
@@ -143,7 +143,12 @@ def add_detection(self,
                       path_class_probability: float = math.nan) -> QuPathPathDetectionObject:
         if self._readonly:
             raise IOError("project in readonly mode")
-        """convenience method for adding detections"""
+        """convenience method for adding detections
+
+        Notes
+        -----
+        these will be added to self.detections
+        """
         obj = QuPathPathDetectionObject.from_shapely(
             roi, path_class, measurements,
             path_class_probability=path_class_probability

diff --git a/setup.cfg b/setup.cfg
@@ -58,6 +58,7 @@ dev =
 docs =
     sphinx
     sphinxemoji
+    sphinx-autodoc-typehints
 
 [options.entry_points]
 console_scripts =