Try numpy-style docstring format

reichlab · Oct 10, 2024 · 36ea5f4 · 36ea5f4
1 parent 4832d02
commit 36ea5f4
Show file tree

Hide file tree

Showing 2 changed files with 13 additions and 6 deletions.
diff --git a/docs/conf.py b/docs/conf.py
@@ -29,6 +29,7 @@
     "sphinx.ext.intersphinx",
     "myst_parser",  # markdown (NOTE: this is NOT mystmd)
     "sphinxext.opengraph",
+    "sphinx.ext.napoleon",
 ]
 
 intersphinx_mapping = {

diff --git a/src/cladetime/cladetime.py b/src/cladetime/cladetime.py
@@ -16,12 +16,18 @@
 class CladeTime:
     """Wrapper around Nextstrain Sars-CoV-2 genome sequences, metadata, and clade assignments.
 
-    :param sequence_as_of Use the NextStrain sequences and sequence metadata
-        that were available as of this date and time (UTC)
-    :type sequence_as_of: datetime
-    :param tree_as_of Use the NextStrain reference tree that was available as
-        of this date and time (UTC).
-    :type tree_as_of: datetime
+    The CladeTime class is instantiated with two optional arguments that
+    specify the point in time at which to access Nextstrain sequence
+    data and the reference tree used to assign sequences to clades.
+
+    Parameters
+    ----------
+    sequence_as_of : datetime
+        Use the NextStrain sequences and sequence metadata that were available
+        as of this date and time (UTC)
+    tree_as_of : datetime
+        Use the NextStrain reference tree that was available as of this date
+        and time (UTC).
     """
 
     def __init__(self, sequence_as_of=None, tree_as_of=None):