sphinx-doc / sphinx-doc/sphinx
autosummary: Keep preserved order of class attributes
Open
Nobody has claimed this yet.
extensions:autosummary
type:proposal
- Dominant language
- Python
- Stars
- 8k
- Forks
- 2.6k
- PR merge metrics
- No merged PRs in 30d
Description
Problem
- Since python 3.6, class definition order is preserved (see PEP-520).
- autosummary should use it by default (instead of alphabet order)
- refs: #4706, #5270
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 locating autosummary's handling of class attributes and checking the related issues #4706 and #5270. Verify the current ordering behavior and identify the relevant regression-test location. Done means autosummary preserves class definition order by default instead of sorting attributes alphabetically.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Feature
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100