Should "See also" be symetric?
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 355
- Forks
- 181
- Avg merge
- 1d 9h
- Merged PRs (30d)
- 3
Description
I learned about the existence of argwhere only recently, although I'm using where very often.
One possible reason for this is that "See also" in the where documentation doesn't link to argwhere, while the latter does link to where.
I guess there must be a programmatic way to make these cross-references symmetric by default, and I wonder if that could be a useful feature for numpydoc...
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 comparing the See also sections in the linked where and argwhere documentation, then inspect numpydoc's handling of cross-references. The work is done when a documented or tested mechanism can make reciprocal See also links appear by default without requiring both references to be written manually.
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
- Mostly clear
- Newbie friendliness
- 35/100