Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation Feature Request: Rolling and Coordinates #3499

Open
rpgoldman opened this issue Nov 8, 2019 · 2 comments
Open

Documentation Feature Request: Rolling and Coordinates #3499

rpgoldman opened this issue Nov 8, 2019 · 2 comments

Comments

@rpgoldman
Copy link
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.
@rpgoldman
Copy link
Contributor Author

A particular ask is "how do we get names (strings) out of the label?"

When I take the list of keys from the label, I get coordinate names, but when I access the coordinate names, I don't get the coordinate values, as I would expect. How do I get these?

@stale
Copy link

stale bot commented Apr 29, 2022

In order to maintain a list of currently relevant issues, we mark issues as stale after a period of inactivity

If this issue remains relevant, please comment here or remove the stale label; otherwise it will be marked as closed automatically

@stale stale bot added the stale label Apr 29, 2022
@dcherian dcherian removed the stale label Apr 29, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants