Multiple reference duplication when loading docstring of function
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 2.5k
- Forks
- 228
- PR merge metrics
- No merged PRs in 30d
Description
Problem Description
Hello - I am using pdoc to compile the docstring of all my methods in my API. But occasionally the references used in the docstring of a specific method are duplicated (or triplicated), and I'm not really sure why.
Please see here, where source code is shown to only contain 2 references, but the resultant pdoc compilation produces duplicates...
Steps to reproduce the behavior:
- I am using the github workflow described by a yml file
System Information
Unable to determine system pdoc version used by the yml file above.
Thank you so much!
Matthew
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 .github/workflows/docs.yml to identify the pdoc version and documentation build command. Reproduce the generated page for orthonormalpolar2D and compare its rendered references with the source docstring. Done means the documented references appear once rather than duplicated.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Bug
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100