POSYDON-code / POSYDON-code/POSYDON
Reformating and updating all docstrings + adding missing ones.
Open
@elizabethteng is already working on this.
Since Oct 14, 2025.
documentation
enhancement
good first issue
P2 - medium priority
- Dominant language
- Python
- Stars
- 45
- Forks
- 37
- Avg merge
- 8d 20h
- Merged PRs (30d)
- 5
Description
With the automatic creation of the reference from the docstrings we need to check them:
- check format:
- here I already checked the format of citations
- mainly checking the correct indentation, missing black lines, and other warnings and errors
- update information, e.g. some have more parameters then explained, or some contain outdated information or the information is too much/less detailed
- add missing ones
Contributor guide
No contributing guide indexed for this repository
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.
Assessment
This issue has not been assessed yet.