issues: 476323960

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
476323960 MDExOlB1bGxSZXF1ZXN0MzAzOTAzNjg1 3180 enable sphinx.ext.napoleon 868027 closed 0     3 2019-08-02T19:26:46Z 2019-08-02T21:17:43Z 2019-08-02T21:17:43Z CONTRIBUTOR   0 pydata/xarray/pulls/3180

Enables the napoleon extension in sphinx. This will interpret the numpydoc style parameters and types and convert them to sphinx :param type name: Note that sphinx.ext.napoleon must come before the numpydoc extension.

Eventually the numpydoc dependency might be able to be removed but currently removing it makes the wrapped ufunc documentation omit the "parameters" and "returns", see the attached screenshot for what one of these ufuncs looks like with numpydoc removed.

  • [ ] Closes #3056

 
{
    "url": "https://api.github.com/repos/pydata/xarray/issues/3180/reactions",
    "total_count": 1,
    "+1": 0,
    "-1": 0,
    "laugh": 0,
    "hooray": 1,
    "confused": 0,
    "heart": 0,
    "rocket": 0,
    "eyes": 0
}
     13221727 pull

Links from other tables