matplotlib / matplotlib/matplotlib.github.com
Canonicalization for 're'-inherited methods
Nobody has claimed this yet.
- Dominant language
- No language data
- Stars
- 29
- Forks
- 62
- PR merge metrics
- No merged PRs in 30d
Description
In 3.4.0, the docs for some `Axes` methods (`pick`, `pickable`, `get_picker`, `set_picker`, `get_contains`, `set_contains`) were removed. This is because the docs are inherited from the `Artist` methods.
Sphinx automatically switches all references when generated the docs, but our redirect/canonicalization script here doesn't recognize it. Instead, it thinks these methods were last documented in 3.3.4 and points there.
We should decide if we want to point to the new location (and figure out if it's possible), and do so.
Contributor guide
No contributing guide indexed for this repository
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 the redirect/canonicalization script and compare its handling of the inherited Artist methods with Sphinx's generated references. Check how the Axes methods are represented after the 3.4.0 documentation removal. Done means the script points these methods to their current canonical location, or clearly records that this is not possible.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100