Merge pull request #147 from TomWagg/docs

Better documentation of class attributes
TomWagg · Nov 13, 2024 · 966f25a · 966f25a
2 parents 97c4eed + 1c28763
commit 966f25a
Show file tree

Hide file tree

Showing 5 changed files with 471 additions and 57 deletions.
diff --git a/cogsworth/classify.py b/cogsworth/classify.py
@@ -33,7 +33,8 @@ def determine_final_classes(population=None, bpp=None, kick_info=None, orbits=No
     Returns
     -------
     classes : :class:`~pandas.DataFrame`
-        A DataFrame with a boolean column for each class (see :meth:`list_classes`) and a row for each binary
+        A DataFrame with a boolean column for each class and a row for each binary.
+        Run :func:`~cogsworth.classify.list_classes` to see the available classes and their criteria.
 
     Raises
     ------