html_url,issue_url,id,node_id,user,created_at,updated_at,author_association,body,reactions,performed_via_github_app,issue
https://github.com/pydata/xarray/issues/3370#issuecomment-1100938840,https://api.github.com/repos/pydata/xarray/issues/3370,1100938840,IC_kwDOAMm_X85Bnv5Y,26384082,2022-04-17T19:43:46Z,2022-04-17T19:43:46Z,NONE,"In order to maintain a list of currently relevant issues, we mark issues as stale after a period of inactivity

If this issue remains relevant, please comment here or remove the `stale` label; otherwise it will be marked as closed automatically
","{""total_count"": 0, ""+1"": 0, ""-1"": 0, ""laugh"": 0, ""hooray"": 0, ""confused"": 0, ""heart"": 0, ""rocket"": 0, ""eyes"": 0}",,502130982
https://github.com/pydata/xarray/issues/3370#issuecomment-663840450,https://api.github.com/repos/pydata/xarray/issues/3370,663840450,MDEyOklzc3VlQ29tbWVudDY2Mzg0MDQ1MA==,14808389,2020-07-25T10:42:39Z,2020-07-25T22:39:01Z,MEMBER,"I've been working on a type preprocessor for napoleon (sphinx-doc/sphinx#7690) which is pretty close (to be included in `sphinx` v3.2.0). Hopefully that will silence all those warnings and also fix most of the broken type links.

Edit: the PR has been merged, so now we only have to wait until the next release of sphinx. That feature is pretty strict about the format of the type spec, so I'll create a PR to update our docstrings.","{""total_count"": 0, ""+1"": 0, ""-1"": 0, ""laugh"": 0, ""hooray"": 0, ""confused"": 0, ""heart"": 0, ""rocket"": 0, ""eyes"": 0}",,502130982
https://github.com/pydata/xarray/issues/3370#issuecomment-594797685,https://api.github.com/repos/pydata/xarray/issues/3370,594797685,MDEyOklzc3VlQ29tbWVudDU5NDc5NzY4NQ==,14808389,2020-03-04T19:56:04Z,2020-03-04T19:56:04Z,MEMBER,"most warnings are due to the bug, yes. The others are broken references to accessor methods like `Dataset.plot.scatter` (see #3625). Last time I checked we did not have new warnings unrelated to the bug, but my `grep` regexp might have missed a few lines.

We could do something to make sure we don't introduce more warnings, though: the nitpicky mode allows ignoring warnings using `nitpick_ignore`, so we might be able to ignore every nitpicky warning related to docstrings / napoleon. We still would need to fix or bypass #3625 first, though.","{""total_count"": 1, ""+1"": 1, ""-1"": 0, ""laugh"": 0, ""hooray"": 0, ""confused"": 0, ""heart"": 0, ""rocket"": 0, ""eyes"": 0}",,502130982
https://github.com/pydata/xarray/issues/3370#issuecomment-594783943,https://api.github.com/repos/pydata/xarray/issues/3370,594783943,MDEyOklzc3VlQ29tbWVudDU5NDc4Mzk0Mw==,868027,2020-03-04T19:38:01Z,2020-03-04T19:38:01Z,CONTRIBUTOR,Every time I see activity on this... I feel like it's [all my fault](https://github.com/pydata/xarray/pull/3180). Feel free to undo whatever is needed.,"{""total_count"": 1, ""+1"": 0, ""-1"": 0, ""laugh"": 1, ""hooray"": 0, ""confused"": 0, ""heart"": 0, ""rocket"": 0, ""eyes"": 0}",,502130982
https://github.com/pydata/xarray/issues/3370#issuecomment-594734114,https://api.github.com/repos/pydata/xarray/issues/3370,594734114,MDEyOklzc3VlQ29tbWVudDU5NDczNDExNA==,5635139,2020-03-04T18:32:53Z,2020-03-04T18:32:53Z,MEMBER,"@keewis I'm guessing we're still stuck on this because of the Napoleon bug? 

Your efforts to quash the previous warnings are laudable, and would be great if we can add tests to ensure they don't creep back in...","{""total_count"": 0, ""+1"": 0, ""-1"": 0, ""laugh"": 0, ""hooray"": 0, ""confused"": 0, ""heart"": 0, ""rocket"": 0, ""eyes"": 0}",,502130982
https://github.com/pydata/xarray/issues/3370#issuecomment-566696534,https://api.github.com/repos/pydata/xarray/issues/3370,566696534,MDEyOklzc3VlQ29tbWVudDU2NjY5NjUzNA==,14808389,2019-12-17T18:47:36Z,2019-12-17T21:20:12Z,MEMBER,"this is not yet fully fixed, we still need to silence the nitpick warnings. That is blocked by the `napoleon` bug, though.","{""total_count"": 0, ""+1"": 0, ""-1"": 0, ""laugh"": 0, ""hooray"": 0, ""confused"": 0, ""heart"": 0, ""rocket"": 0, ""eyes"": 0}",,502130982
https://github.com/pydata/xarray/issues/3370#issuecomment-564124368,https://api.github.com/repos/pydata/xarray/issues/3370,564124368,MDEyOklzc3VlQ29tbWVudDU2NDEyNDM2OA==,14808389,2019-12-10T16:48:05Z,2019-12-10T16:48:05Z,MEMBER,"looks like I was wrong, `numpydoc` does not have much to do with this. The real culprit is `napoleon`: see sphinx-doc/sphinx#6861","{""total_count"": 0, ""+1"": 0, ""-1"": 0, ""laugh"": 0, ""hooray"": 0, ""confused"": 0, ""heart"": 0, ""rocket"": 0, ""eyes"": 0}",,502130982
https://github.com/pydata/xarray/issues/3370#issuecomment-562582121,https://api.github.com/repos/pydata/xarray/issues/3370,562582121,MDEyOklzc3VlQ29tbWVudDU2MjU4MjEyMQ==,14808389,2019-12-06T14:00:22Z,2019-12-06T14:18:08Z,MEMBER,"most of the nitpicky errors are raised because numpydoc tries to link to parameter types. We can define aliases and ignore terms like `instance` or words like `of`, see

https://github.com/mne-tools/mne-python/blob/da9cd19a9b65e792e2523f159820549ec6082f9d/doc/conf.py#L531-L616

for an example. We can also ignore nitpicky warnings using [`nitpick_ignore`](https://www.sphinx-doc.org/en/master/usage/configuration.html#confval-nitpick_ignore), but the normal warnings can't be selectively ignored ([`suppress_warnings`](https://www.sphinx-doc.org/en/master/usage/configuration.html#confval-suppress_warnings) ignores warning categories).","{""total_count"": 1, ""+1"": 1, ""-1"": 0, ""laugh"": 0, ""hooray"": 0, ""confused"": 0, ""heart"": 0, ""rocket"": 0, ""eyes"": 0}",,502130982
https://github.com/pydata/xarray/issues/3370#issuecomment-548414737,https://api.github.com/repos/pydata/xarray/issues/3370,548414737,MDEyOklzc3VlQ29tbWVudDU0ODQxNDczNw==,5635139,2019-10-31T14:54:33Z,2019-10-31T14:54:33Z,MEMBER,"> Is there a sphinx or restructured text linter that we can run? e.g. https://github.com/PyCQA/doc8

Looks reasonable; though this is a checker rather than fixer","{""total_count"": 0, ""+1"": 0, ""-1"": 0, ""laugh"": 0, ""hooray"": 0, ""confused"": 0, ""heart"": 0, ""rocket"": 0, ""eyes"": 0}",,502130982
https://github.com/pydata/xarray/issues/3370#issuecomment-548414589,https://api.github.com/repos/pydata/xarray/issues/3370,548414589,MDEyOklzc3VlQ29tbWVudDU0ODQxNDU4OQ==,5635139,2019-10-31T14:54:16Z,2019-10-31T14:54:16Z,MEMBER,"I ran https://github.com/myint/docformatter on our code `docformatter --in-place -r --wrap-summaries=88 . `; results [here](https://github.com/pydata/xarray/compare/master...max-sixty:docformatter?expand=1)

But it doesn't solve many of our issues, which are around the sphinx docstrings 

Happy to do a PR, but worry it's more churn than help?","{""total_count"": 0, ""+1"": 0, ""-1"": 0, ""laugh"": 0, ""hooray"": 0, ""confused"": 0, ""heart"": 0, ""rocket"": 0, ""eyes"": 0}",,502130982
https://github.com/pydata/xarray/issues/3370#issuecomment-548408079,https://api.github.com/repos/pydata/xarray/issues/3370,548408079,MDEyOklzc3VlQ29tbWVudDU0ODQwODA3OQ==,5635139,2019-10-31T14:41:06Z,2019-10-31T14:41:06Z,MEMBER,"
> The sphinx log states:
> 
> /home/docs/checkouts/readthedocs.org/user_builds/xray/conda/latest/lib/python3.7/site-packages/xarray-0.14.0+37.g96cc2bc6-py3.7.egg/xarray/core/dataset.py:docstring of xarray.Dataset.integrate:12: WARNING: Unexpected indentation.

That's a good case...
","{""total_count"": 0, ""+1"": 0, ""-1"": 0, ""laugh"": 0, ""hooray"": 0, ""confused"": 0, ""heart"": 0, ""rocket"": 0, ""eyes"": 0}",,502130982
https://github.com/pydata/xarray/issues/3370#issuecomment-548340818,https://api.github.com/repos/pydata/xarray/issues/3370,548340818,MDEyOklzc3VlQ29tbWVudDU0ODM0MDgxOA==,6213168,2019-10-31T12:07:21Z,2019-10-31T12:07:21Z,MEMBER,"Yes. For example

http://xarray.pydata.org/en/stable/generated/xarray.Dataset.integrate.html#xarray.Dataset.integrate

The sphinx log states:

/home/docs/checkouts/readthedocs.org/user_builds/xray/conda/latest/lib/python3.7/site-packages/xarray-0.14.0+37.g96cc2bc6-py3.7.egg/xarray/core/dataset.py:docstring of xarray.Dataset.integrate:12: WARNING: Unexpected indentation.

What I just now noticed is that several docstrings may be imported from numpy - which complicates everything.","{""total_count"": 1, ""+1"": 1, ""-1"": 0, ""laugh"": 0, ""hooray"": 0, ""confused"": 0, ""heart"": 0, ""rocket"": 0, ""eyes"": 0}",,502130982
https://github.com/pydata/xarray/issues/3370#issuecomment-547749938,https://api.github.com/repos/pydata/xarray/issues/3370,547749938,MDEyOklzc3VlQ29tbWVudDU0Nzc0OTkzOA==,5635139,2019-10-30T05:57:53Z,2019-10-30T05:57:53Z,MEMBER,"Do these matter?

Do we know of examples of bad outcomes (e.g. hard-to-read docs)?","{""total_count"": 0, ""+1"": 0, ""-1"": 0, ""laugh"": 0, ""hooray"": 0, ""confused"": 0, ""heart"": 0, ""rocket"": 0, ""eyes"": 0}",,502130982
https://github.com/pydata/xarray/issues/3370#issuecomment-542509292,https://api.github.com/repos/pydata/xarray/issues/3370,542509292,MDEyOklzc3VlQ29tbWVudDU0MjUwOTI5Mg==,2448579,2019-10-16T04:35:02Z,2019-10-16T04:35:02Z,MEMBER,Is there a sphinx or restructured text linter that we can run? e.g. https://github.com/PyCQA/doc8,"{""total_count"": 0, ""+1"": 0, ""-1"": 0, ""laugh"": 0, ""hooray"": 0, ""confused"": 0, ""heart"": 0, ""rocket"": 0, ""eyes"": 0}",,502130982