matplotlib / matplotlib/matplotlib
[Doc]: Document setters and getters from private superclasses
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 23.2k
- Forks
- 8.5k
- Avg merge
- 1d 6h
- Merged PRs (30d)
- 66
Description
### Documentation Link
https://matplotlib.org/devdocs/api/image_api.html#matplotlib.image.AxesImage.set
### Problem
The above is one example, but there are some cases where the superclass is common and therefore the corresponding setters and getters are not documented. For images, it is `alpha`, `array`, `data`, `filternorm`, `filterrad`, `interpolation`, `interpolation_stage`, and `resample` that has getters and setters with doc-strings, but since `_ImageBase` is private they are not shown.
Also, other common methods as `can_composite`, `get_size`, `get_shape`, and `write_png` are shown in the documentation.
### Suggested improvement
Figure out how to add these in a good way. There are probably more classes where this happens.
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 from the linked AxesImage.set documentation and inspect how inherited members from the private _ImageBase superclass are currently exposed. Document the listed image getters and setters without exposing inappropriate private APIs, and check whether other classes have the same omission.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100