Skip to content

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

Merged

Conversation

jorisvandenbossche
Copy link
Member

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.

@codecov
Copy link

codecov bot commented Jun 13, 2019

Codecov Report

Merging #26834 into master will increase coverage by 1.4%.
The diff coverage is n/a.

Impacted file tree graph

@@            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
Flag Coverage Δ
#multiple 90.45% <ø> (ø) ⬆️
#single 41.12% <ø> (?)
Impacted Files Coverage Δ
pandas/core/arrays/integer.py 96.3% <ø> (ø) ⬆️
pandas/core/arrays/sparse.py 93.71% <ø> (ø) ⬆️
pandas/core/arrays/timedeltas.py 88.82% <ø> (ø) ⬆️
pandas/core/arrays/period.py 98.54% <ø> (ø) ⬆️
pandas/core/arrays/numpy_.py 94.49% <ø> (ø) ⬆️
pandas/core/arrays/datetimes.py 97.79% <ø> (ø) ⬆️
pandas/util/testing.py 90.94% <0%> (+0.1%) ⬆️
pandas/core/arrays/categorical.py 95.92% <0%> (+0.12%) ⬆️
pandas/core/indexes/datetimes.py 96.37% <0%> (+0.16%) ⬆️
pandas/io/formats/printing.py 85.56% <0%> (+1.06%) ⬆️
... and 5 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update e8132a2...11fbd96. Read the comment docs.

@codecov
Copy link

codecov bot commented Jun 13, 2019

Codecov Report

Merging #26834 into master will increase coverage by 1.4%.
The diff coverage is n/a.

Impacted file tree graph

@@            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
Flag Coverage Δ
#multiple 90.45% <ø> (-0.01%) ⬇️
#single 41.12% <ø> (?)
Impacted Files Coverage Δ
pandas/core/arrays/integer.py 96.3% <ø> (ø) ⬆️
pandas/core/arrays/sparse.py 93.59% <ø> (-0.12%) ⬇️
pandas/core/arrays/timedeltas.py 88.82% <ø> (ø) ⬆️
pandas/core/arrays/period.py 98.3% <ø> (-0.25%) ⬇️
pandas/core/arrays/numpy_.py 94.49% <ø> (ø) ⬆️
pandas/core/arrays/datetimes.py 97.79% <ø> (ø) ⬆️
pandas/core/arrays/base.py 98.87% <0%> (-0.57%) ⬇️
pandas/io/formats/format.py 97.89% <0%> (-0.02%) ⬇️
... and 11 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update e8132a2...7ad3b5d. Read the comment docs.

@datapythonista
Copy link
Member

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:

checking consistency... /home/vsts/work/1/s/doc/source/reference/api/pandas.Index.asi8.rst: WARNING: document isn't included in any toctree
/home/vsts/work/1/s/doc/source/reference/api/pandas.Index.holds_integer.rst: WARNING: document isn't included in any toctree
/home/vsts/work/1/s/doc/source/reference/api/pandas.Index.is_type_compatible.rst: WARNING: document isn't included in any toctree
/home/vsts/work/1/s/doc/source/reference/api/pandas.Index.nlevels.rst: WARNING: document isn't included in any toctree
/home/vsts/work/1/s/doc/source/reference/api/pandas.Index.sort.rst: WARNING: document isn't included in any toctree
/home/vsts/work/1/s/doc/source/reference/api/pandas.api.extensions.ExtensionDtype.na_value.rst: WARNING: document isn't included in any toctree

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.

@jorisvandenbossche
Copy link
Member Author

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.

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)

@jorisvandenbossche
Copy link
Member Author

Failure is unrelated, seeing it regularly, opened an issue: #26842

@jorisvandenbossche jorisvandenbossche merged commit 14ee9de into pandas-dev:master Jun 14, 2019
@jorisvandenbossche jorisvandenbossche deleted the doc-api-arrays branch June 14, 2019 06:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants