issue_comments

Table actions

9 rows where issue = 1497131525 sorted by updated_at descending

✎ View and edit SQL

This data as json, CSV (advanced)

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

author_association 3

issue 1

  • Improve docstrings for better discoverability · 9 ✖
id html_url issue_url node_id user created_at updated_at ▲ author_association body reactions performed_via_github_app issue
1493220291 https://github.com/pydata/xarray/issues/7378#issuecomment-1493220291 https://api.github.com/repos/pydata/xarray/issues/7378 IC_kwDOAMm_X85ZALvD dcherian 2448579 2023-04-02T04:26:57Z 2023-04-02T04:26:57Z MEMBER

would one have to create these names for each method?

Yes I think so.

xarray.Dataset.var suggests to see numpy.var which is about computing variance but I don't want to guess wrong.

Yes things like var, std etc. are pretty standard so you should able to find them. If not, feel free to ask !

 
{
    "total_count": 0,
    "+1": 0,
    "-1": 0,
    "laugh": 0,
    "hooray": 0,
    "confused": 0,
    "heart": 0,
    "rocket": 0,
    "eyes": 0
}
   Improve docstrings for better discoverability 1497131525
1492985937 https://github.com/pydata/xarray/issues/7378#issuecomment-1492985937 https://api.github.com/repos/pydata/xarray/issues/7378 IC_kwDOAMm_X85Y_ShR Ravenin7 99545557 2023-04-01T14:26:10Z 2023-04-01T14:26:10Z CONTRIBUTOR

Hey @TomNicholas . You mentioned one way of fixing this issue would be to also use long_name in the template to be more descriptive. Is there an already existing list of these names somewhere that could be used for this purpose or would one have to create these names for each method? Also, if it is the latter, do you have any suggestion(s) for how I should figure these names out? I wouldn't have known that var stood for variance if I hadn't read it here. I may have guessed it as xarray.Dataset.var suggests to see numpy.var which is about computing variance but I don't want to guess wrong.

 
{
    "total_count": 0,
    "+1": 0,
    "-1": 0,
    "laugh": 0,
    "hooray": 0,
    "confused": 0,
    "heart": 0,
    "rocket": 0,
    "eyes": 0
}
   Improve docstrings for better discoverability 1497131525
1485891524 https://github.com/pydata/xarray/issues/7378#issuecomment-1485891524 https://api.github.com/repos/pydata/xarray/issues/7378 IC_kwDOAMm_X85YkOfE TomNicholas 35968931 2023-03-27T21:35:14Z 2023-03-27T21:35:14Z MEMBER

Hi @Amisha2778 - great to hear you are interested. You don't need my permission - please have a go at solving any issue that looks interesting to you, and please ask questions if you have any difficulties!

 
{
    "total_count": 0,
    "+1": 0,
    "-1": 0,
    "laugh": 0,
    "hooray": 0,
    "confused": 0,
    "heart": 0,
    "rocket": 0,
    "eyes": 0
}
   Improve docstrings for better discoverability 1497131525
1484212554 https://github.com/pydata/xarray/issues/7378#issuecomment-1484212554 https://api.github.com/repos/pydata/xarray/issues/7378 IC_kwDOAMm_X85Yd0lK Amisha2778 100865724 2023-03-26T20:22:07Z 2023-03-26T20:22:07Z NONE

Hey @TomNicholas I am an Outreachy applicant. I would like to work on this issue.

 
{
    "total_count": 0,
    "+1": 0,
    "-1": 0,
    "laugh": 0,
    "hooray": 0,
    "confused": 0,
    "heart": 0,
    "rocket": 0,
    "eyes": 0
}
   Improve docstrings for better discoverability 1497131525
1464851909 https://github.com/pydata/xarray/issues/7378#issuecomment-1464851909 https://api.github.com/repos/pydata/xarray/issues/7378 IC_kwDOAMm_X85XT93F mahamtariq58 11984160 2023-03-11T07:36:34Z 2023-03-11T07:36:34Z NONE

Okay thank you @TomNicholas 

{
    "total_count": 0,
    "+1": 0,
    "-1": 0,
    "laugh": 0,
    "hooray": 0,
    "confused": 0,
    "heart": 0,
    "rocket": 0,
    "eyes": 0
}
   Improve docstrings for better discoverability 1497131525
1463915266 https://github.com/pydata/xarray/issues/7378#issuecomment-1463915266 https://api.github.com/repos/pydata/xarray/issues/7378 IC_kwDOAMm_X85XQZMC TomNicholas 35968931 2023-03-10T14:50:52Z 2023-03-10T14:50:52Z MEMBER

Hi @mahamtariq58, thanks for your interest! We don't normally assign issues to individuals, you are just welcome to have a go at solving any issue that interests you.

 
{
    "total_count": 0,
    "+1": 0,
    "-1": 0,
    "laugh": 0,
    "hooray": 0,
    "confused": 0,
    "heart": 0,
    "rocket": 0,
    "eyes": 0
}
   Improve docstrings for better discoverability 1497131525
1463275577 https://github.com/pydata/xarray/issues/7378#issuecomment-1463275577 https://api.github.com/repos/pydata/xarray/issues/7378 IC_kwDOAMm_X85XN9A5 mahamtariq58 11984160 2023-03-10T04:58:30Z 2023-03-10T04:58:30Z NONE

Hi @TomNicholas , I would like to contribute to this issue.Could I be assigned to it?

 
{
    "total_count": 0,
    "+1": 0,
    "-1": 0,
    "laugh": 0,
    "hooray": 0,
    "confused": 0,
    "heart": 0,
    "rocket": 0,
    "eyes": 0
}
   Improve docstrings for better discoverability 1497131525
1357341994 https://github.com/pydata/xarray/issues/7378#issuecomment-1357341994 https://api.github.com/repos/pydata/xarray/issues/7378 IC_kwDOAMm_X85Q52Uq maawoo 56583917 2022-12-19T09:21:05Z 2022-12-19T09:21:05Z CONTRIBUTOR

Hi @TomNicholas, thanks for your response! I'd be happy to contribute and will see what I can do once I find some spare time 🙂 

{
    "total_count": 2,
    "+1": 0,
    "-1": 0,
    "laugh": 0,
    "hooray": 0,
    "confused": 0,
    "heart": 2,
    "rocket": 0,
    "eyes": 0
}
   Improve docstrings for better discoverability 1497131525
1351995978 https://github.com/pydata/xarray/issues/7378#issuecomment-1351995978 https://api.github.com/repos/pydata/xarray/issues/7378 IC_kwDOAMm_X85QldJK TomNicholas 35968931 2022-12-14T19:05:19Z 2022-12-14T19:05:19Z MEMBER

That's a useful observation, thank you @maawoo!

This comes from the way we generate our code for the many different aggregations xarray can perform. We actually use this script to automatically generate all the source code for all the aggregations in this file. That script has a template that is filled in for each method.

Currently the template looks like this

python TEMPLATE_REDUCTION_SIGNATURE = ''' def {method}( self, dim: Dims = None, *,{extra_kwargs} keep_attrs: bool | None = None, **kwargs: Any, ) -> {obj}: """ Reduce this {obj}'s data by applying ``{method}`` along some dimension(s). Parameters ----------''' where in the case of variance the method is just var so "variance" isn't in the generated docstring anywhere.

How might we fix this? One immediate thought that might help is to change the template to use a method_name and a long_name, where method_name is var but long_name is variance for example. This shouldn't be particularly difficult, and we would welcome a PR if you would be interested in contributing? We would help you out :slightly_smiling_face:

Or we might change the docstrings in some other, more granular way. Adding examples to aggregation methods would also have to deal with the fact they are autogenerated https://github.com/pydata/xarray/issues/6793

 
{
    "total_count": 0,
    "+1": 0,
    "-1": 0,
    "laugh": 0,
    "hooray": 0,
    "confused": 0,
    "heart": 0,
    "rocket": 0,
    "eyes": 0
}
   Improve docstrings for better discoverability 1497131525

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