issue_comments

Table actions

9 rows where author_association = "MEMBER" and issue = 476222321 sorted by updated_at descending

✎ View and edit SQL

This data as json, CSV (advanced)

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

user 3

issue 1

  • type annotations make docs confusing · 9 ✖

author_association 1

  • MEMBER · 9 ✖
id html_url issue_url node_id user created_at updated_at ▲ author_association body reactions performed_via_github_app issue
555738582 https://github.com/pydata/xarray/issues/3178#issuecomment-555738582 https://api.github.com/repos/pydata/xarray/issues/3178 MDEyOklzc3VlQ29tbWVudDU1NTczODU4Mg== crusaderky 6213168 2019-11-19T22:08:05Z 2019-11-19T22:08:05Z MEMBER

I tried using sphinx-autodoc-typehints in my own project but I'm getting a gazillion of errors. TypeVars don't work, Optional doesn't work, Literal doesn't work, intersphinx doesn't work (https://github.com/agronholm/sphinx-autodoc-typehints/issues/119), possibly more (the error log is just too long). :(

 
{
    "total_count": 0,
    "+1": 0,
    "-1": 0,
    "laugh": 0,
    "hooray": 0,
    "confused": 0,
    "heart": 0,
    "rocket": 0,
    "eyes": 0
}
   type annotations make docs confusing 476222321
555694791 https://github.com/pydata/xarray/issues/3178#issuecomment-555694791 https://api.github.com/repos/pydata/xarray/issues/3178 MDEyOklzc3VlQ29tbWVudDU1NTY5NDc5MQ== dcherian 2448579 2019-11-19T20:21:02Z 2019-11-19T20:21:02Z MEMBER

Looks like this isn't fully fixed

 
{
    "total_count": 0,
    "+1": 0,
    "-1": 0,
    "laugh": 0,
    "hooray": 0,
    "confused": 0,
    "heart": 0,
    "rocket": 0,
    "eyes": 0
}
   type annotations make docs confusing 476222321
517804369 https://github.com/pydata/xarray/issues/3178#issuecomment-517804369 https://api.github.com/repos/pydata/xarray/issues/3178 MDEyOklzc3VlQ29tbWVudDUxNzgwNDM2OQ== shoyer 1217238 2019-08-02T18:39:10Z 2019-08-02T18:39:10Z MEMBER

Yes, this is great! Please send a PR when you're ready :)

 
{
    "total_count": 0,
    "+1": 0,
    "-1": 0,
    "laugh": 0,
    "hooray": 0,
    "confused": 0,
    "heart": 0,
    "rocket": 0,
    "eyes": 0
}
   type annotations make docs confusing 476222321
517800769 https://github.com/pydata/xarray/issues/3178#issuecomment-517800769 https://api.github.com/repos/pydata/xarray/issues/3178 MDEyOklzc3VlQ29tbWVudDUxNzgwMDc2OQ== dcherian 2448579 2019-08-02T18:26:31Z 2019-08-02T18:26:31Z MEMBER

+1 I like the style with Napoleon enabled. It even fixes #3056.

 
{
    "total_count": 0,
    "+1": 0,
    "-1": 0,
    "laugh": 0,
    "hooray": 0,
    "confused": 0,
    "heart": 0,
    "rocket": 0,
    "eyes": 0
}
   type annotations make docs confusing 476222321
517792673 https://github.com/pydata/xarray/issues/3178#issuecomment-517792673 https://api.github.com/repos/pydata/xarray/issues/3178 MDEyOklzc3VlQ29tbWVudDUxNzc5MjY3Mw== shoyer 1217238 2019-08-02T17:58:45Z 2019-08-02T17:58:45Z MEMBER

I would be OK with stripping type hints entirely. Our long type annotations are mostly useful for tooling. The short annotations from our numpy-style docstrings are definitely more readable for humans.

 
{
    "total_count": 0,
    "+1": 0,
    "-1": 0,
    "laugh": 0,
    "hooray": 0,
    "confused": 0,
    "heart": 0,
    "rocket": 0,
    "eyes": 0
}
   type annotations make docs confusing 476222321
517775102 https://github.com/pydata/xarray/issues/3178#issuecomment-517775102 https://api.github.com/repos/pydata/xarray/issues/3178 MDEyOklzc3VlQ29tbWVudDUxNzc3NTEwMg== dcherian 2448579 2019-08-02T17:02:09Z 2019-08-02T17:02:09Z MEMBER

Have you enabled napoleon_use_param? (https://stackoverflow.com/questions/49540656/how-to-automatically-add-parameter-types-in-sphinx-documentation)

Add 'sphinx_autodoc_typehints' to the extensions list in conf.py after 'sphinx.ext.napoleon', and make sure you also add napoleon_use_param = True to conf.py.

 
{
    "total_count": 0,
    "+1": 0,
    "-1": 0,
    "laugh": 0,
    "hooray": 0,
    "confused": 0,
    "heart": 0,
    "rocket": 0,
    "eyes": 0
}
   type annotations make docs confusing 476222321
517774635 https://github.com/pydata/xarray/issues/3178#issuecomment-517774635 https://api.github.com/repos/pydata/xarray/issues/3178 MDEyOklzc3VlQ29tbWVudDUxNzc3NDYzNQ== dcherian 2448579 2019-08-02T17:00:44Z 2019-08-02T17:01:19Z MEMBER

EDIT: ignore, I see you've tried napoleon

 
{
    "total_count": 0,
    "+1": 0,
    "-1": 0,
    "laugh": 0,
    "hooray": 0,
    "confused": 0,
    "heart": 0,
    "rocket": 0,
    "eyes": 0
}
   type annotations make docs confusing 476222321
517754667 https://github.com/pydata/xarray/issues/3178#issuecomment-517754667 https://api.github.com/repos/pydata/xarray/issues/3178 MDEyOklzc3VlQ29tbWVudDUxNzc1NDY2Nw== shoyer 1217238 2019-08-02T15:59:16Z 2019-08-02T15:59:16Z MEMBER

If we can't get that sphinx extension to work (I'm not sure if it will handle NumPy style docstrings), another option might to be define type aliases for the longer types, e.g., data_vars: DataVars. That would at least cut down on the noise.

 
{
    "total_count": 0,
    "+1": 0,
    "-1": 0,
    "laugh": 0,
    "hooray": 0,
    "confused": 0,
    "heart": 0,
    "rocket": 0,
    "eyes": 0
}
   type annotations make docs confusing 476222321
517739583 https://github.com/pydata/xarray/issues/3178#issuecomment-517739583 https://api.github.com/repos/pydata/xarray/issues/3178 MDEyOklzc3VlQ29tbWVudDUxNzczOTU4Mw== dcherian 2448579 2019-08-02T15:17:03Z 2019-08-02T15:17:03Z MEMBER

Thanks @DocOtak. Are you interested in trying it out?

 
{
    "total_count": 0,
    "+1": 0,
    "-1": 0,
    "laugh": 0,
    "hooray": 0,
    "confused": 0,
    "heart": 0,
    "rocket": 0,
    "eyes": 0
}
   type annotations make docs confusing 476222321

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]);