You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository was archived by the owner on Nov 23, 2024. It is now read-only.
Currently, we always jump directly to the class to find the documentation. This is incorrect for matplotlib.
Desired solution
First, check the docstring of the class. If nothing is found there, check the docstring of the __init__ method. This should be decided for each parameter. Example:
classC:
""" Parameters ---------- x: str Lorem ipsum 1. z: str Lorem ipsum 3. """def__init__(self, x, y, z):
""" Parameters ---------- y: str Lorem ipsum 2. z: str Lorem ipsum 4. """
For x the description should be "Lorem ipsum 1.". For y the description should be "Lorem ipsum 2.". For z the description should be "Lorem ipsum 3."