OpenwaterHealth / OpenwaterHealth/openlifu-python
Document openlifu
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 27
- Forks
- 21
- Avg merge
- 1d 20m
- Merged PRs (30d)
- 6
Description
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:
(Here we see the attributes of a Session are documented at the class level rather than on the attributes themselves.)
Update: More generally, this issue can represent the project of documenting OpenLIFU-python.
Traceability Information:
- Issue: OpenLIFU-python#129
- SOFTREQ: OpenLIFU-python#338
- Comment: This issue is related to the requirements defined in OpenLIFU-python#338.
This information was populated automatically by a script on 2025-06-09T18:01:39Z.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the example in src/openlifu/db/session.py, especially lines 27–43, and compare the Session dataclass attributes with their class-level documentation. Then inspect the surrounding OpenLIFU-python code to identify other undocumented items. Done means the documented information is attached to the things it documents, but this issue does not define a bounded set of files or a test command.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100