HathorNetwork / HathorNetwork/hathor-core
Define standard for docstring
- Dominant language
- Python
- Stars
- 92
- Forks
- 45
- PR merge metrics
- No merged PRs in 30d
Description
We've been using some different spacing/line-breaks for docstrings.
We need to define:
1. Should we have a space after the initial `"""`?
2. Do we ident the all lines to match the first line?
Some examples:
Contributor guide
No contributing guide indexed for this repository
Research direction
Start by reviewing the four docstring examples in the issue and comparing them with existing Python docstrings in the repository. Done means the project has one agreed convention covering spacing after the opening triple quotes and indentation of subsequent lines, with that convention documented for future contributors.
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
- Mostly clear
- Newbie friendliness
- 30/100