Support typing[_extensions].Doc
Open
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 355
- Forks
- 181
- Avg merge
- 1d 9h
- Merged PRs (30d)
- 3
Description
When(/if) https://peps.python.org/pep-0727/ is adopted then parameter and return/yield descriptions can be attached directly to the type. Having a "Parameters" section or a "Returns" section in the docs will not be necessary. Numpydoc should support typing[_extensions].Doc and the changes it implies to the docstring sections.
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 reading PEP 727 and reviewing how numpydoc currently handles Parameters and Returns sections. Define the behavior for typing.Doc annotations and the resulting docstring sections; done means supported parameter and return/yield descriptions can be attached directly to types.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100