Silence sphinx warnings: Round 2 #3592
Conversation
sphinx' doctest extension does not work too well with them.
|
Great!! Will be good to get CI up & running. Should we add that as part of this PR? |
this will probably make doctest fail but it fixes the sphinx warnings.
|
do we agree on dropping |
I think this is OK. If it gets too annoying, we can revert
I think this is OK too. The attributes seem to get added to the html documentation automatically. The list you removed is formatted kind of badly at the beginning of the docstring. see the end of https://xarray.pydata.org/en/stable/generated/xarray.DataArray.html |
|
I'll update the CI, then. We could also have CI run doctest so we know which examples need updates, but we'd first need fix all outdated examples. |
|
now CI should fail on new warnings (no nit-picks, so no complaints about broken links). I will open a new PR later to silence the nitpicky warnings. |
dcherian
changed the title
|
Looks great!! Really good that we can enforce the warnings from here (I'm on vacation so forgive the lack of engagement) |
|
Thanks @keewis |
* upstream/master: Fix map_blocks HLG layering (pydata#3598) Silence sphinx warnings: Round 2 (pydata#3592) 2x~5x speed up for isel() in most cases (pydata#3533) remove xarray again (pydata#3591) fix plotting with transposed nondim coords. (pydata#3441) make coarsen reductions consistent with reductions on other classes (pydata#3500) Resolve the version issues on RTD (pydata#3589) Add bottleneck & rasterio git tip to upstream-dev CI (pydata#3585)
…equiv * 'master' of github.com:pydata/xarray: (28 commits) Add nanmedian for dask arrays (pydata#3604) added pyinterp to related projects (pydata#3655) Allow incomplete hypercubes in combine_by_coords (pydata#3649) concat keeps attrs from first variable. (pydata#3637) Extend DatetimeAccessor properties and support `.dt` accessor for Timedelta (pydata#3612) update readthedocs.yml (pydata#3639) silence sphinx warnings round 3 (pydata#3602) Fix/quantile wrong errmsg (pydata#3635) Provide shape info in shape mismatch error. (pydata#3619) Minor doc fixes (pydata#3615) Respect user-specified coordinates attribute. (pydata#3487) Add Facetgrid.row_labels & Facetgrid.col_labels (pydata#3597) Fix pint integration tests (pydata#3600) Minor fix to combine_by_coords to allow for the combination of CFTimeIndexes separated by large time intervals (pydata#3543) Fix map_blocks HLG layering (pydata#3598) Silence sphinx warnings: Round 2 (pydata#3592) 2x~5x speed up for isel() in most cases (pydata#3533) remove xarray again (pydata#3591) fix plotting with transposed nondim coords. (pydata#3441) make coarsen reductions consistent with reductions on other classes (pydata#3500) ...
As a follow-up to #3516, this silences the last warnings without
-n, so once the doctest issue below is fixed we could replace-nwith-W --keep-goingand have the CI fail should a PR introduce new warnings.There is, however, a problem with the doctest output for the 3D result of
GroupBy.quantile: since the repr of a DataArray with at least 3 dimensions contains blank lines, it complains about a block quote ending without a blank line.Also, the complaints from #3516 about duplicate definitions of attributes were caused by the
Attributessection in the docstring ofDataArray. I fixed this by removing the whole section, but we probably want to first make sure this does not remove any information (or maybe someone has a different idea?).black . && mypy . && flake8