issue_comments

Table actions

12 rows where author_association = "MEMBER" and issue = 502130982 sorted by updated_at descending

✎ View and edit SQL

This data as json, CSV (advanced)

Suggested facets: reactions, created_at (date), updated_at (date)

issue 1

  • Hundreds of Sphinx errors · 12 ✖

author_association 1

  • MEMBER · 12 ✖
id html_url issue_url node_id user created_at updated_at ▲ author_association body reactions performed_via_github_app issue
663840450 https://github.com/pydata/xarray/issues/3370#issuecomment-663840450 https://api.github.com/repos/pydata/xarray/issues/3370 MDEyOklzc3VlQ29tbWVudDY2Mzg0MDQ1MA== keewis 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
}
   Hundreds of Sphinx errors 502130982
594797685 https://github.com/pydata/xarray/issues/3370#issuecomment-594797685 https://api.github.com/repos/pydata/xarray/issues/3370 MDEyOklzc3VlQ29tbWVudDU5NDc5NzY4NQ== keewis 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
}
   Hundreds of Sphinx errors 502130982
594734114 https://github.com/pydata/xarray/issues/3370#issuecomment-594734114 https://api.github.com/repos/pydata/xarray/issues/3370 MDEyOklzc3VlQ29tbWVudDU5NDczNDExNA== max-sixty 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
}
   Hundreds of Sphinx errors 502130982
566696534 https://github.com/pydata/xarray/issues/3370#issuecomment-566696534 https://api.github.com/repos/pydata/xarray/issues/3370 MDEyOklzc3VlQ29tbWVudDU2NjY5NjUzNA== keewis 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
}
   Hundreds of Sphinx errors 502130982
564124368 https://github.com/pydata/xarray/issues/3370#issuecomment-564124368 https://api.github.com/repos/pydata/xarray/issues/3370 MDEyOklzc3VlQ29tbWVudDU2NDEyNDM2OA== keewis 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
}
   Hundreds of Sphinx errors 502130982
562582121 https://github.com/pydata/xarray/issues/3370#issuecomment-562582121 https://api.github.com/repos/pydata/xarray/issues/3370 MDEyOklzc3VlQ29tbWVudDU2MjU4MjEyMQ== keewis 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, but the normal warnings can't be selectively ignored (suppress_warnings ignores warning categories).

 
{
    "total_count": 1,
    "+1": 1,
    "-1": 0,
    "laugh": 0,
    "hooray": 0,
    "confused": 0,
    "heart": 0,
    "rocket": 0,
    "eyes": 0
}
   Hundreds of Sphinx errors 502130982
548414737 https://github.com/pydata/xarray/issues/3370#issuecomment-548414737 https://api.github.com/repos/pydata/xarray/issues/3370 MDEyOklzc3VlQ29tbWVudDU0ODQxNDczNw== max-sixty 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
}
   Hundreds of Sphinx errors 502130982
548414589 https://github.com/pydata/xarray/issues/3370#issuecomment-548414589 https://api.github.com/repos/pydata/xarray/issues/3370 MDEyOklzc3VlQ29tbWVudDU0ODQxNDU4OQ== max-sixty 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

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
}
   Hundreds of Sphinx errors 502130982
548408079 https://github.com/pydata/xarray/issues/3370#issuecomment-548408079 https://api.github.com/repos/pydata/xarray/issues/3370 MDEyOklzc3VlQ29tbWVudDU0ODQwODA3OQ== max-sixty 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
}
   Hundreds of Sphinx errors 502130982
548340818 https://github.com/pydata/xarray/issues/3370#issuecomment-548340818 https://api.github.com/repos/pydata/xarray/issues/3370 MDEyOklzc3VlQ29tbWVudDU0ODM0MDgxOA== crusaderky 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
}
   Hundreds of Sphinx errors 502130982
547749938 https://github.com/pydata/xarray/issues/3370#issuecomment-547749938 https://api.github.com/repos/pydata/xarray/issues/3370 MDEyOklzc3VlQ29tbWVudDU0Nzc0OTkzOA== max-sixty 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
}
   Hundreds of Sphinx errors 502130982
542509292 https://github.com/pydata/xarray/issues/3370#issuecomment-542509292 https://api.github.com/repos/pydata/xarray/issues/3370 MDEyOklzc3VlQ29tbWVudDU0MjUwOTI5Mg== dcherian 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
}
   Hundreds of Sphinx errors 502130982

Advanced export

JSON shape: default, array, newline-delimited, object

CSV options: 

CREATE TABLE [issue_comments] (
   [html_url] TEXT,
   [issue_url] TEXT,
   [id] INTEGER PRIMARY KEY,
   [node_id] TEXT,
   [user] INTEGER REFERENCES [users]([id]),
   [created_at] TEXT,
   [updated_at] TEXT,
   [author_association] TEXT,
   [body] TEXT,
   [reactions] TEXT,
   [performed_via_github_app] TEXT,
   [issue] INTEGER REFERENCES [issues]([id])
);
CREATE INDEX [idx_issue_comments_issue]
    ON [issue_comments] ([issue]);
CREATE INDEX [idx_issue_comments_user]
    ON [issue_comments] ([user]);