generated from carpentries-incubator/python-intermediate-inflammation
-
Notifications
You must be signed in to change notification settings - Fork 2
Open
Labels
documentationImprovements or additions to documentationImprovements or additions to documentationshould haveImportant but not necessary for delivery in the timeboxImportant but not necessary for delivery in the timebox
Milestone
Description
The following classes and their methods could use more information in the Docstring, as they stand right now there is no basic information regarding them and their methods, while the code is quite clear, Sphinx is ignoring them when autogenerating docs:
python-intermediate-inflammation/inflammation/models.py
Lines 12 to 13 in 2ab4726
class Observation: def __init__(self, day: int, value, doctor=None) -> None: python-intermediate-inflammation/inflammation/models.py
Lines 30 to 31 in 2ab4726
class Patient(Person): def __init__(self, name: str, observations=None) -> None: python-intermediate-inflammation/inflammation/models.py
Lines 22 to 23 in 2ab4726
class Person: def __init__(self,name: str) -> None: python-intermediate-inflammation/inflammation/models.py
Lines 56 to 57 in 2ab4726
class Doctor(Person): def __init__(self, name: str, patients: list) -> None:
Metadata
Metadata
Assignees
Labels
documentationImprovements or additions to documentationImprovements or additions to documentationshould haveImportant but not necessary for delivery in the timeboxImportant but not necessary for delivery in the timebox