pydata / pydata/xarray

Documentation Feature Request: Rolling and Coordinates

Open
#3,499 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

topic-documentation topic-rolling
Dominant language
Python
Stars
4.2k
Forks
1.4k
Avg merge
2d 15h
Merged PRs (30d)
14

Description

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.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Locate the documentation section describing iteration over Rolling objects, the document generator, and the Coordinate API documentation. First inspect how rolling examples and API-reference entries are generated; done means the example explains label and arr_window, Coordinate docstrings appear in the API reference, and the rolling section links to it.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
38/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.