Convert docstrings into standard (propose Google) docstring format
Open
@sadielbartholomew is already working on this.
Since Mar 18, 2024.
code hygiene
docs
- Dominant language
- Python
- Stars
- 21
- Forks
- 11
- Avg merge
- 7h 11m
- Merged PRs (30d)
- 1
Description
Presently the docstrings in the codebase are in some format I do not recognise, so we should convert them into a standardised format that is recognised by the Sphinx docs builder.
Since cf-python uses a format closely aligned with the Google standard, it makes sense to be consistent with that and to use the same, so that is my choice unless anyone has any objections.
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.
Assessment
This issue has not been assessed yet.