-
-
Notifications
You must be signed in to change notification settings - Fork 18.4k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
DOC: document optional arguments on plot submethods #11042
Labels
Comments
I would like to work on this issue, if it is still available? |
is this issue still open ... after almost a decade ? |
1 task
is this issue still up , can i work on this ? |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
As a follow up on #9321:
We should start adding optional arguments that are common between multiple plot types to the signatures for plotting sub-methods, such as
figsize
andaxis
. Currently, these are only documented on the main.plot()
methods and we use**kwargs
for the rest. This would be nice because we could clarify for users which optional arguments work for which types of plots -- this is not at all obvious right now.@JanSchulz suggests we could perhaps do this dynamically by updating the
__signature__
object. However, I don't know yet if this will generate the correct API documentation -- maybe if Sphinx is run using Python 3?The text was updated successfully, but these errors were encountered: