issue_comments

Table actions

6 rows where issue = 500949040 sorted by updated_at descending

✎ View and edit SQL

This data as json, CSV (advanced)

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

user 5

author_association 2

issue 1

  • Recommendations for domain-specific accessor documentation · 6 ✖
id html_url issue_url node_id user created_at updated_at ▲ author_association body reactions performed_via_github_app issue
652396487 https://github.com/pydata/xarray/issues/3361#issuecomment-652396487 https://api.github.com/repos/pydata/xarray/issues/3361 MDEyOklzc3VlQ29tbWVudDY1MjM5NjQ4Nw== keewis 14808389 2020-07-01T12:45:19Z 2020-07-02T11:44:07Z MEMBER

I created such a package since I think I'm going to need that for pint-xarray. It currently lives at https://github.com/keewis/sphinx-autosummary-accessors

 
{
    "total_count": 3,
    "+1": 3,
    "-1": 0,
    "laugh": 0,
    "hooray": 0,
    "confused": 0,
    "heart": 0,
    "rocket": 0,
    "eyes": 0
}
   Recommendations for domain-specific accessor documentation 500949040
625553307 https://github.com/pydata/xarray/issues/3361#issuecomment-625553307 https://api.github.com/repos/pydata/xarray/issues/3361 MDEyOklzc3VlQ29tbWVudDYyNTU1MzMwNw== shoyer 1217238 2020-05-07T23:49:51Z 2020-05-07T23:49:51Z MEMBER

I think a documentation build only dependency would be very easy for both xarray and pandas to use. So a separate package (a sphinx extension?) sounds like a good idea.

 
{
    "total_count": 0,
    "+1": 0,
    "-1": 0,
    "laugh": 0,
    "hooray": 0,
    "confused": 0,
    "heart": 0,
    "rocket": 0,
    "eyes": 0
}
   Recommendations for domain-specific accessor documentation 500949040
618370835 https://github.com/pydata/xarray/issues/3361#issuecomment-618370835 https://api.github.com/repos/pydata/xarray/issues/3361 MDEyOklzc3VlQ29tbWVudDYxODM3MDgzNQ== benbovy 4160723 2020-04-23T12:22:16Z 2020-04-23T12:22:16Z MEMBER

I think to make this a bit easier for everyone we should add this to the documentation on accessors.

Agreed, this would definitely be useful.

Also, we could create a sphinx extension module that contains all the code in conf.py

I also agree! Since the code in conf.py is exactly the same for both pandas and xarray, it would be nice to hear thoughts from pandas developers @jorisvandenbossche.

 
{
    "total_count": 3,
    "+1": 3,
    "-1": 0,
    "laugh": 0,
    "hooray": 0,
    "confused": 0,
    "heart": 0,
    "rocket": 0,
    "eyes": 0
}
   Recommendations for domain-specific accessor documentation 500949040
618338469 https://github.com/pydata/xarray/issues/3361#issuecomment-618338469 https://api.github.com/repos/pydata/xarray/issues/3361 MDEyOklzc3VlQ29tbWVudDYxODMzODQ2OQ== keewis 14808389 2020-04-23T11:06:54Z 2020-04-23T11:06:54Z MEMBER

comment from @benbovy in #3625:

I re-used pandas templates for xarray accessors here: https://github.com/benbovy/xarray-simlab/blob/45359e99cbf6341464b02cb937618c051a58a31c/doc/conf.py#L233

It works pretty well: https://xarray-simlab.readthedocs.io/en/latest/api.html#dataset-xsimlab-xarray-accessor

For reference, here's pandas' version: https://github.com/pandas-dev/pandas/blob/837daf18d480cce18c25844c591c39da19437252/doc/source/conf.py#L441-L591

I think to make this a bit easier for everyone we should add this to the documentation on accessors.

Also, we could create a sphinx extension module that contains all the code in conf.py so defining the custom directives would be as simple as adding something like "xarray.doc.accessors" to extensions. The module doesn't have to be in xarray, though, it could also become a separate package.

 
{
    "total_count": 0,
    "+1": 0,
    "-1": 0,
    "laugh": 0,
    "hooray": 0,
    "confused": 0,
    "heart": 0,
    "rocket": 0,
    "eyes": 0
}
   Recommendations for domain-specific accessor documentation 500949040
537669216 https://github.com/pydata/xarray/issues/3361#issuecomment-537669216 https://api.github.com/repos/pydata/xarray/issues/3361 MDEyOklzc3VlQ29tbWVudDUzNzY2OTIxNg== gmaze 1956032 2019-10-02T20:35:26Z 2019-10-02T20:35:26Z CONTRIBUTOR

Thanks for the example @jthielen, this looks great !

May be it would be better to not show to readers the accessor class name, since it will never be seen on the API frontend, only the scope name will.

So it would be great to be able to have the documentation to read something like:

xarray.DataSet.<scope_name>.<accessor_method_or_property>

instead of:

<package_name>.xarray.<accessor_class_name>.<accessor_method_or_property> (in the case where the accessor class is in xarray.py file on the package)

But I don't know how to manage that with sphinx documentation

 
{
    "total_count": 0,
    "+1": 0,
    "-1": 0,
    "laugh": 0,
    "hooray": 0,
    "confused": 0,
    "heart": 0,
    "rocket": 0,
    "eyes": 0
}
   Recommendations for domain-specific accessor documentation 500949040
537564221 https://github.com/pydata/xarray/issues/3361#issuecomment-537564221 https://api.github.com/repos/pydata/xarray/issues/3361 MDEyOklzc3VlQ29tbWVudDUzNzU2NDIyMQ== jthielen 3460034 2019-10-02T16:05:57Z 2019-10-02T16:05:57Z CONTRIBUTOR

@gmaze Just as an example, here is what we recently added for MetPy: https://unidata.github.io/MetPy/latest/api/generated/metpy.xarray.html. Previously, we just had a narrative-form tutorial.

If there are other recommendations, it would be great to incorporate those into MetPy as well!

 
{
    "total_count": 0,
    "+1": 0,
    "-1": 0,
    "laugh": 0,
    "hooray": 0,
    "confused": 0,
    "heart": 0,
    "rocket": 0,
    "eyes": 0
}
   Recommendations for domain-specific accessor documentation 500949040

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