Open ebrahimebrahim opened 1 month ago
This is a running issue to track the requirement of having docstrings on the things that they document.
An example where this is not the case is many of the dataclass attributes, such as this:
https://github.com/OpenwaterHealth/OpenLIFU-python/blob/d322c3a8e927b86d82027e63ea226566c2a4f9fe/src/openlifu/db/session.py#L27-L43
(Here we see the attributes of a Session are documented at the class level rather than on the attributes themselves.)
This is a running issue to track the requirement of having docstrings on the things that they document.
An example where this is not the case is many of the dataclass attributes, such as this:
https://github.com/OpenwaterHealth/OpenLIFU-python/blob/d322c3a8e927b86d82027e63ea226566c2a4f9fe/src/openlifu/db/session.py#L27-L43
(Here we see the attributes of a Session are documented at the class level rather than on the attributes themselves.)