issue_comments

Table actions

10 rows where issue = 1306795760 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 with examples and links · 10 ✖
id html_url issue_url node_id user created_at updated_at ▲ author_association body reactions performed_via_github_app issue
1483090261 https://github.com/pydata/xarray/issues/6793#issuecomment-1483090261 https://api.github.com/repos/pydata/xarray/issues/6793 IC_kwDOAMm_X85YZilV dcherian 2448579 2023-03-24T16:33:28Z 2023-03-24T16:33:28Z MEMBER

Thanks @Mehak-4545 . I think we need to fix that.

For now, you'll have to find the .py file for that method and edit the docstring manually. See #7669 for an example.

 
{
    "total_count": 0,
    "+1": 0,
    "-1": 0,
    "laugh": 0,
    "hooray": 0,
    "confused": 0,
    "heart": 0,
    "rocket": 0,
    "eyes": 0
}
   improve docstrings with examples and links 1306795760
1480127638 https://github.com/pydata/xarray/issues/6793#issuecomment-1480127638 https://api.github.com/repos/pydata/xarray/issues/6793 IC_kwDOAMm_X85YOPSW Mehak-4545 103323828 2023-03-22T19:18:11Z 2023-03-22T19:18:11Z NONE

Sure @dcherian, I shall do that. Thank you for responding! One concern I had regarding this is that when I click on "suggest edit" for documentation of a specific method on the xarray documentation, I am lead to the repo, but the path for those methods is not cantained in the repository. The issue can be seen in the screenshot attached. Is there some other procedure I have to follow to update the documentation? Thanks again! 

{
    "total_count": 0,
    "+1": 0,
    "-1": 0,
    "laugh": 0,
    "hooray": 0,
    "confused": 0,
    "heart": 0,
    "rocket": 0,
    "eyes": 0
}
   improve docstrings with examples and links 1306795760
1480092926 https://github.com/pydata/xarray/issues/6793#issuecomment-1480092926 https://api.github.com/repos/pydata/xarray/issues/6793 IC_kwDOAMm_X85YOGz- dcherian 2448579 2023-03-22T18:50:09Z 2023-03-22T18:50:09Z MEMBER

Hi @Mehak-4545 welcome to Xarray! Thank you for taking the time to contribute.

We don't assign issues usually. And this one is pretty comprehensive. Why don't you pick a few and comment here so that there are no overlapping efforts.

Please open a pull request and comment there if you have questions

 
{
    "total_count": 0,
    "+1": 0,
    "-1": 0,
    "laugh": 0,
    "hooray": 0,
    "confused": 0,
    "heart": 0,
    "rocket": 0,
    "eyes": 0
}
   improve docstrings with examples and links 1306795760
1480053648 https://github.com/pydata/xarray/issues/6793#issuecomment-1480053648 https://api.github.com/repos/pydata/xarray/issues/6793 IC_kwDOAMm_X85YN9OQ Mehak-4545 103323828 2023-03-22T18:21:10Z 2023-03-22T18:21:10Z NONE

Hello @keewis! I'm Mehak, an Outreachy applicant from India in the July 2023 cohort. I would like to take up this issue and improve the documentation of some of the methods mentioned in the list. Can this issue be assigned to me?

 
{
    "total_count": 0,
    "+1": 0,
    "-1": 0,
    "laugh": 0,
    "hooray": 0,
    "confused": 0,
    "heart": 0,
    "rocket": 0,
    "eyes": 0
}
   improve docstrings with examples and links 1306795760
1276551898 https://github.com/pydata/xarray/issues/6793#issuecomment-1276551898 https://api.github.com/repos/pydata/xarray/issues/6793 IC_kwDOAMm_X85MFqLa DanielGoman 22195223 2022-10-12T18:08:28Z 2022-10-12T18:08:28Z CONTRIBUTOR

I have added several docstring examples in #7123, but the CI fails on some checks that (to me) don't seem related to the examples I added.

I'd appreciate if anybody could clarify this to me before I turn the draft to a PR :)

 
{
    "total_count": 0,
    "+1": 0,
    "-1": 0,
    "laugh": 0,
    "hooray": 0,
    "confused": 0,
    "heart": 0,
    "rocket": 0,
    "eyes": 0
}
   improve docstrings with examples and links 1306795760
1265498342 https://github.com/pydata/xarray/issues/6793#issuecomment-1265498342 https://api.github.com/repos/pydata/xarray/issues/6793 IC_kwDOAMm_X85Lbfjm DanielGoman 22195223 2022-10-03T14:07:31Z 2022-10-03T14:07:31Z CONTRIBUTOR

Excellent, I'll start working on it, thank you!

 
{
    "total_count": 0,
    "+1": 0,
    "-1": 0,
    "laugh": 0,
    "hooray": 0,
    "confused": 0,
    "heart": 0,
    "rocket": 0,
    "eyes": 0
}
   improve docstrings with examples and links 1306795760
1265441985 https://github.com/pydata/xarray/issues/6793#issuecomment-1265441985 https://api.github.com/repos/pydata/xarray/issues/6793 IC_kwDOAMm_X85LbRzB keewis 14808389 2022-10-03T13:28:50Z 2022-10-03T13:28:50Z MEMBER

yep, basically that, but linking to other sections in the documentation or related functions / methods is valuable as well (the "See Also" section).

Have a look at #7088 for a recent PR on this, although it's probably better to do one method at a time (it's up to you whether you want to work on the Dataset and DataArray version at the same time, though).

Don't hesitate to ask if you need help (either here, or in your PR).

 
{
    "total_count": 0,
    "+1": 0,
    "-1": 0,
    "laugh": 0,
    "hooray": 0,
    "confused": 0,
    "heart": 0,
    "rocket": 0,
    "eyes": 0
}
   improve docstrings with examples and links 1306795760
1265413908 https://github.com/pydata/xarray/issues/6793#issuecomment-1265413908 https://api.github.com/repos/pydata/xarray/issues/6793 IC_kwDOAMm_X85LbK8U DanielGoman 22195223 2022-10-03T13:08:37Z 2022-10-03T13:08:37Z CONTRIBUTOR

Hello :) I'm new to open source contribution. I'd like to work on this issue. As far as I understand, all there is to do is to add examples to the documentation and to verify the correctness of those examples. Am I correct?

 
{
    "total_count": 0,
    "+1": 0,
    "-1": 0,
    "laugh": 0,
    "hooray": 0,
    "confused": 0,
    "heart": 0,
    "rocket": 0,
    "eyes": 0
}
   improve docstrings with examples and links 1306795760
1186195540 https://github.com/pydata/xarray/issues/6793#issuecomment-1186195540 https://api.github.com/repos/pydata/xarray/issues/6793 IC_kwDOAMm_X85Gs-hU keewis 14808389 2022-07-16T14:16:13Z 2022-07-16T14:27:23Z MEMBER

I thought I ran it on main, but apparently I made a mistake? You're right, the aggregations and thin have examples now, but head and tail don't

 
{
    "total_count": 1,
    "+1": 1,
    "-1": 0,
    "laugh": 0,
    "hooray": 0,
    "confused": 0,
    "heart": 0,
    "rocket": 0,
    "eyes": 0
}
   improve docstrings with examples and links 1306795760
1186194293 https://github.com/pydata/xarray/issues/6793#issuecomment-1186194293 https://api.github.com/repos/pydata/xarray/issues/6793 IC_kwDOAMm_X85Gs-N1 dcherian 2448579 2022-07-16T14:10:37Z 2022-07-16T14:10:37Z MEMBER

Thanks @keewis this is a great list

I guess you didn't run this on main?

The reductions all..var should have examples now. So do head tail and thin. the cumulative functions are injected so that may be too complex.

 
{
    "total_count": 0,
    "+1": 0,
    "-1": 0,
    "laugh": 0,
    "hooray": 0,
    "confused": 0,
    "heart": 0,
    "rocket": 0,
    "eyes": 0
}
   improve docstrings with examples and links 1306795760

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