Wish: Custom sections
Open
Nobody has claimed this yet.
help-wanted
type: Enhancement
- Dominant language
- Python
- Stars
- 355
- Forks
- 181
- Avg merge
- 1d 9h
- Merged PRs (30d)
- 3
Description
I would like to be able to define custom sections so they don't create warnings when I use them.
This would be very helpful in our project: https://github.com/chime-experiment/dias
for example here
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 dias/analyzers/feedpositions_analyzer.py example and trace how numpydoc currently handles unknown sections and emits warnings. Define the expected custom-section behavior and verify that the example no longer produces warnings, with coverage for the supported configuration.
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
- 25/100