Consistent usage of `Notes` and `Note` sections
Open
Nobody has claimed this yet.
⬇ low priority
📚 documentation
- Dominant language
- Python
- Stars
- 7
- Forks
- 10
- Avg merge
- 1d 19h
- Merged PRs (30d)
- 5
Description
# 📚 Documentation Request
## Addition
We use both `Notes` and `Note` sections in docstrings in ANTS. We should standardise how we use this by:
1. Defining a convention in the working practices
2. Updating existing docstrings to match that convention
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 by reviewing the working-practices documentation and searching the ANTS codebase for docstrings using `Notes` or `Note`. Agree on the convention, document it in working practices, and update all existing docstrings to match; completion means the guidance and usages are consistent.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100