pdoc incorrectly orders references with numpy formatting
Open
Nobody has claimed this yet.
bug
- Dominant language
- Python
- Stars
- 2.5k
- Forks
- 228
- PR merge metrics
- No merged PRs in 30d
Description
Problem Description
Looking at the source code for the orientation function in this link, you will see that the ordering of references is incorrect. In the source code, the order that the references appear is 1,2,3 but after pdoc compilation we get 2,3,1.
Steps to reproduce the behavior:
System Information
Looking at the build log here, pdoc version is 15.0.3
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
Reproduce the ordering problem using the shapelets orientation documentation, the .github/workflows/docs.yml GitHub Action, and pdoc 15.0.3. Compare the source reference order with the generated page and build log; done means generated NumPy-formatted references preserve the source order 1, 2, 3.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- numpy, python
- Domain
- documentation
- Issue type
- Bug
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100