Show decorator and link to it?
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 1.2k
- Forks
- 146
- PR merge metrics
- No merged PRs in 30d
Description
Pydoc currently does not indicate in any way that a function or other object has a decorator. But decorators are
often used to change or add to the way how a e.g. a function can be used by the API user. So documenting this is very important.
Ideally the generated documentation would show the decorator as in the source and allow to link to the documentation of the decorator implementation.
Documenting this manually for each function can be very repetitive when the same decorator is e.g. used for a large number of class 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 by reviewing pydoc's handling of function and object signatures in the generated documentation. Trace how decorators are represented, including repeated decorators on class methods and links to their implementations. Done means the generated documentation consistently shows decorators and links to their documentation where possible; no files or tests are named in the issue.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100