DOC: Explicitly include "private" ExtensionArray methods in API docs #27279
Conversation
tadeja
force-pushed
the
docs-for-private-extensionarray-methods
branch
from
36b6efb to
e8c5df7
Compare
| See Also | ||
| -------- | ||
| numpy.take | ||
| api.extensions.take |
There was a problem hiding this comment.
Can you leave the pandas. here?
There was a problem hiding this comment.
@jorisvandenbossche
I've removed pandas. to resolve the Docstring validation error. From CI:
pandas/core/arrays/base.py(770,): error SA05: pandas.api.extensions.ExtensionArray.take: pandas.api.extensions.take in `See Also` section does not need `pandas` prefix, use api.extensions.take instead.
What do you recommend to do?
There was a problem hiding this comment.
I dislike this listing rule in this case. I believe it's to ensure we consistently do things like DataFrame.merge instead of pandas.DataFrame.merge.
But I think the (redundant) namespacing here is helpful here since I wouldn't immediately associate api... with pandas.api....
Regardless, for now we can just please the linter.
|
@tadeja can you take a look at the built docs at http://pandas-docs.github.io/pandas-docs-travis/reference/api/pandas.api.extensions.ExtensionArray.html#pandas.api.extensions.ExtensionArray when the CI build on master for this finishes? |
|
Thanks! It looks good over here: ... while this one appears unchanged and I am just wondering if that's going to be OK: |
|
I don't think the second one is being updated anymore.
…On Tue, Jul 16, 2019 at 4:58 PM tadeja ***@***.***> wrote:
Thanks! It looks good over here:
https://dev.pandas.io/reference/api/pandas.api.extensions.ExtensionArray.html#pandas.api.extensions.ExtensionArray
(Date: Jul 16, 2019 Version: 0.25.0rc0+76.g26bd34df2)
... while this one appears unchanged and I am just wondering if that's
going to be OK:
http://pandas-docs.github.io/pandas-docs-travis/reference/api/pandas.api.extensions.ExtensionArray.html#pandas.api.extensions.ExtensionArray
(Date: Jun 18, 2019 Version: 0.25.0.dev0+752.g49f33f0d)
—
You are receiving this because you modified the open/close state.
Reply to this email directly, view it on GitHub
<#27279?email_source=notifications&email_token=AAKAOIV6DZCZEPF2HBJ636LP7ZABZA5CNFSM4H6WHX62YY3PNVWWK3TUL52HS4DFVREXG43VMVBW63LNMVXHJKTDN5WW2ZLOORPWSZGOD2CI7PQ#issuecomment-512004030>,
or mute the thread
<https://github.com/notifications/unsubscribe-auth/AAKAOISXWBWS2OM5BJC2VNLP7ZABZANCNFSM4H6WHX6Q>
.
|
git diff upstream/master -u -- "*.py" | flake8 --diff