move json sort note to dump
Open
Nobody has claimed this yet.
docs
- Dominant language
- Python
- Stars
- 77.2k
- Forks
- 35.9k
- PR merge metrics
- PR metrics pending
Description
Documentation
As noted in bug #135623 the https://cpython-previews--156987.org.readthedocs.build/en/156987/library/json.html dump/dumps has an important note on sorting, which is oddly in dumps, whereas dump is the primary source of documentation, with dumps just otherwise being a pointer to dump.
As such, the note should be moved to dump.
Linked PRs
- gh-157577
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 library/json.html documentation linked in the issue and compare the dump and dumps entries. Done means the sorting note appears under dump rather than dumps; gh-157577 is already linked to this work.
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
- 20/100