Documenting constants should indicate how to do this technically
Open
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 355
- Forks
- 181
- Avg merge
- 1d 9h
- Merged PRs (30d)
- 3
Description
In documenting constants, the guide says what sections should be used to document constants, but it does not say how to technically do so. From the answers to a Stackoverflow question, I've learned there are two ways to do so:
#: before the constant.
FOOD = "spam"
or
FOOD = "spam"
"""After the constant"""
The documentation should mention this and perhaps recommend of of those methods.
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 linked “documenting constants” section in the format guide and inspect how that documentation is organized in the repository. Explain both supported constant-documentation forms and recommend one, then verify the rendered guide clearly communicates the technical syntax and resulting documentation behavior.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 55/100