issues: 607814501

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
607814501 MDExOlB1bGxSZXF1ZXN0NDA5NzE1MTUz 4012 Apply blackdoc to the documentation 14808389 closed 0     6 2020-04-27T20:00:15Z 2020-04-29T16:20:01Z 2020-04-29T16:10:10Z MEMBER   0 pydata/xarray/pulls/4012

This applies black to the code in the documentation using blackdoc. The tool itself is not stable or released yet, but this demonstrate the upcoming support for rst code blocks, including the ipython sphinx directive. There are a few issues with the latter, e.g. the semi-colon to suppress output will be removed by black. In a few cases this changes the other outputs, mostly plots. I think we might fix/work around that by moving the line decorator to the last line that should be plotted (which is what I did), but we could also use the ipython syntax with cell decorators: python @savefig ... In [1]: # code ...: # with multiple lines

Also, while I checked the changes manually, please don't take my word for it: I'm really not sure I didn't miss anything. I know this is a rather large PR so I'm fine with waiting.

  • [x] Passes isort -rc . && black . && mypy . && flake8
  • [x] Fully documented, including whats-new.rst for all changes and api.rst for new API
 
{
    "url": "https://api.github.com/repos/pydata/xarray/issues/4012/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