issues: 534329975

This data as json

id node_id number title user state locked assignee milestone comments created_at updated_at closed_at author_association active_lock_reason draft pull_request body reactions performed_via_github_app state_reason repo type
534329975 MDExOlB1bGxSZXF1ZXN0MzUwMjU4MDYx 3602 silence sphinx warnings round 3 14808389 closed 0     12 2019-12-07T01:02:44Z 2019-12-17T16:45:18Z 2019-12-17T16:25:27Z MEMBER   0 pydata/xarray/pulls/3602

In this last "sphinx warnings" PR the goal is to silence all nit-picky warnings that are not related to napoleon's interpretation of parameter types. ~In https://github.com/pydata/xarray/issues/3370#issuecomment-562582121 I posted ways to define type aliases (so dict-like points to the term mapping on https://docs.python.org/3/ and array-like to the appropriate page in the numpy docs) or to ignore words like of. This PR applies these to silence all the nit-picky warnings (which mostly means broken links).~

~As a reference for myself, the documentation of numpydoc's sphinx config options is here: https://numpydoc.readthedocs.io/en/latest/install.html#sphinx-config-options~ numpydoc does not have anything to do with this, we are blocked by a bug in napoleon (see #3370).

At the moment only the autodoc / autosummary / ~numpydoc~ napoleon warnings remain, with a few exceptions in whats-new.rst.

In theory we could also re-enable -n and use the nitpick_ignore settings to ignore any unfixable warnings, but I'm undecided about whether that would be a good idea. Thoughts?

  • [x] Closes #3370
  • [ ] Fully documented, including whats-new.rst for all changes and api.rst for new API
 
{
    "url": "https://api.github.com/repos/pydata/xarray/issues/3602/reactions",
    "total_count": 2,
    "+1": 0,
    "-1": 0,
    "laugh": 0,
    "hooray": 0,
    "confused": 0,
    "heart": 2,
    "rocket": 0,
    "eyes": 0
}
     13221727 pull

Links from other tables