-
-
Notifications
You must be signed in to change notification settings - Fork 18.4k
DOC: array class docstring pages without autosummary tables #26834
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: array class docstring pages without autosummary tables #26834
Conversation
Codecov Report
@@ Coverage Diff @@
## master #26834 +/- ##
=========================================
+ Coverage 90.45% 91.86% +1.4%
=========================================
Files 179 179
Lines 50706 50706
=========================================
+ Hits 45866 46579 +713
+ Misses 4840 4127 -713
Continue to review full report at Codecov.
|
Codecov Report
@@ Coverage Diff @@
## master #26834 +/- ##
=========================================
+ Coverage 90.45% 91.85% +1.4%
=========================================
Files 179 179
Lines 50706 50700 -6
=========================================
+ Hits 45866 46572 +706
+ Misses 4840 4128 -712
Continue to review full report at Codecov.
|
Looks great, you just need to fix the order of sections in couple of classes, but this fixes all the warnings. We still have some, but they are unrelated, looks like something is not working for some cases with the "hack" we've got to not have in the API some public methods:
I see most of the methods listed in https://github.com/pandas-dev/pandas/blame/master/doc/source/reference/index.rst#L44 not generating warnings, but those do. Once we merge this PR and #26810, I'll create issues for the few warnings left, and let's see if we can get a clean build before warnings start reproducing again. |
I suppose we can remove those that generate a warning from that list ... (the reason they get a warning is, I think, because for some reason the class docstring autosummary does not list them. Maybe it has to do with a missing docstring (which could actually be fixed) or otherwise being a special function/attribute object) |
Failure is unrelated, seeing it regularly, opened an issue: #26842 |
See discussion in #26810
This just adds the "class_without_autosummary". Longer term, we could choose to add certain methods of the Array API to the html api pages, but for now just wanted to do this to get rid of the warnings.