issues: 520137402

This data as json

id node_id number title user state locked assignee milestone comments created_at updated_at closed_at author_association active_lock_reason draft pull_request body reactions performed_via_github_app state_reason repo type
520137402 MDU6SXNzdWU1MjAxMzc0MDI= 3499 Documentation Feature Request: Rolling and Coordinates 3274 open 0     2 2019-11-08T17:24:40Z 2022-04-29T17:39:44Z   CONTRIBUTOR      

The documentation about iteration with rolling contains the following:

We can also manually iterate through Rolling objects:

for label, arr_window in r:
   # arr_window is a view of x

It would help to explain what sort of thing label is, and how we can use it. It seems to be an object of type Coordinate, but Coordinate does not appear in the API reference.

So I would suggest the two following improvements:

  1. Add an example of using the label and arr_window, maybe plotting the arr_window with the label used to give title.
  2. Tweak the document generator to include docstrings from Coordinate in the API reference section.
  3. Crossreference (hyperlink) from this section of the doc text to the API reference.
 
{
    "url": "https://api.github.com/repos/pydata/xarray/issues/3499/reactions",
    "total_count": 0,
    "+1": 0,
    "-1": 0,
    "laugh": 0,
    "hooray": 0,
    "confused": 0,
    "heart": 0,
    "rocket": 0,
    "eyes": 0
}
     13221727 issue

Links from other tables