issue_comments

Table actions

5 rows where issue = 407750967 sorted by updated_at descending

✖
✖

✎ View and edit SQL

This data as json, CSV (advanced)

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

author_association 2

issue 1

  • document defaults for optional arguments to open_dataset, open_mfdataset · 5 ✖
id html_url issue_url node_id user created_at updated_at ▲ author_association body reactions performed_via_github_app issue
461542898 https://github.com/pydata/xarray/issues/2752#issuecomment-461542898 https://api.github.com/repos/pydata/xarray/issues/2752 MDEyOklzc3VlQ29tbWVudDQ2MTU0Mjg5OA== shoyer 1217238 2019-02-07T18:28:57Z 2019-02-07T18:28:57Z MEMBER

One thing I'll mention is that we often try not to specify defaults in both docstrings and function signatures, because this can lead to the defaults getting out of sync. This leads to only putting defaults in the function signature itself, because that part is tested by the code.

 
{
    "total_count": 0,
    "+1": 0,
    "-1": 0,
    "laugh": 0,
    "hooray": 0,
    "confused": 0,
    "heart": 0,
    "rocket": 0,
    "eyes": 0
}
   document defaults for optional arguments to open_dataset, open_mfdataset 407750967
461527174 https://github.com/pydata/xarray/issues/2752#issuecomment-461527174 https://api.github.com/repos/pydata/xarray/issues/2752 MDEyOklzc3VlQ29tbWVudDQ2MTUyNzE3NA== jhamman 2443309 2019-02-07T17:44:12Z 2019-02-07T17:44:12Z MEMBER

@klindsay28, if you're up for it, we'd be happy to accept some changes to these docstrings to improve consistency between the signature and doc string.

 
{
    "total_count": 0,
    "+1": 0,
    "-1": 0,
    "laugh": 0,
    "hooray": 0,
    "confused": 0,
    "heart": 0,
    "rocket": 0,
    "eyes": 0
}
   document defaults for optional arguments to open_dataset, open_mfdataset 407750967
461519515 https://github.com/pydata/xarray/issues/2752#issuecomment-461519515 https://api.github.com/repos/pydata/xarray/issues/2752 MDEyOklzc3VlQ29tbWVudDQ2MTUxOTUxNQ== klindsay28 15570875 2019-02-07T17:22:49Z 2019-02-07T17:22:49Z NONE

Thanks for the quick responses @jhamman and @dcherian. I had focused on the descriptive text below the function signature, which mentions defaults for some, but not all arguments. I now realize that I need to also examine the function signature in the docs. Sorry for the noise.

 
{
    "total_count": 0,
    "+1": 0,
    "-1": 0,
    "laugh": 0,
    "hooray": 0,
    "confused": 0,
    "heart": 0,
    "rocket": 0,
    "eyes": 0
}
   document defaults for optional arguments to open_dataset, open_mfdataset 407750967
461494903 https://github.com/pydata/xarray/issues/2752#issuecomment-461494903 https://api.github.com/repos/pydata/xarray/issues/2752 MDEyOklzc3VlQ29tbWVudDQ2MTQ5NDkwMw== dcherian 2448579 2019-02-07T16:20:39Z 2019-02-07T16:20:39Z MEMBER

@klindsay28 The top line shows the function signature which has the defaults listed.

xarray.open_dataset(filename_or_obj, group=None, decode_cf=True, mask_and_scale=None, decode_times=True, autoclose=None, concat_characters=True, decode_coords=True, engine=None, chunks=None, lock=None, cache=None, drop_variables=None, backend_kwargs=None)

I agree that this is confusing.

 
{
    "total_count": 0,
    "+1": 0,
    "-1": 0,
    "laugh": 0,
    "hooray": 0,
    "confused": 0,
    "heart": 0,
    "rocket": 0,
    "eyes": 0
}
   document defaults for optional arguments to open_dataset, open_mfdataset 407750967
461490623 https://github.com/pydata/xarray/issues/2752#issuecomment-461490623 https://api.github.com/repos/pydata/xarray/issues/2752 MDEyOklzc3VlQ29tbWVudDQ2MTQ5MDYyMw== jhamman 2443309 2019-02-07T16:12:08Z 2019-02-07T16:12:08Z MEMBER

@klindsay28 - thanks for opening an issue. We're always trying to improve our documentation. However, When I look at the docs for these two functions, I see the defaults for decode_coords=True, decode_times=True, data_vars='all', and coords='different'.

 
{
    "total_count": 0,
    "+1": 0,
    "-1": 0,
    "laugh": 0,
    "hooray": 0,
    "confused": 0,
    "heart": 0,
    "rocket": 0,
    "eyes": 0
}
   document defaults for optional arguments to open_dataset, open_mfdataset 407750967

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