-
-
Notifications
You must be signed in to change notification settings - Fork 1.1k
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
signature in accessor methods #4152
Comments
it seems fixing both the signature and the summary is a bit more involved than I thought and probably either requires changes to |
I hacked around that issue in the PR so this issue would be fixed by switching to |
actually, it seems RTD unpinned the dependency versions (not sure when they did that) so we might even be able to make use of the hack. So: should we try using that package by installing from github, or would it be better to wait until there's a released version available? |
unfortunately, |
the issue is that we use # Build on the original docstring
dummy.__doc__ = f"{plotfunc.__doc__}\n{commondoc}"
# to shorten the signature
@functools.wraps(plotfunc)
def dummy(darray, x, y, **kwargs):
pass
# use the signature of dummy
del dummy.__wrapped__
@functools.wraps(dummy)
def newplotfunc( instead of Lines 572 to 576 in 1791c3b
|
With the merge of #3988 we're now properly documenting the
str
,dt
andplot
accessors, but the signatures of the plotting methods are missing a few parameters. For example,DataArray.plot.contour
is missing the parameterx
(it's properly documented in the parameters section, though).Also, we need to remove the
str
anddt
accessors fromComputing
and try to figure out how to fix the summary ofDataArray.plot
(the plotting method).The text was updated successfully, but these errors were encountered: