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

Fix docstring on rolling_window #324

Open
santisoler opened this issue May 11, 2021 · 0 comments
Open

Fix docstring on rolling_window #324

santisoler opened this issue May 11, 2021 · 0 comments
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers (doesn’t require deep knowledge of the project)
Milestone

Comments

@santisoler
Copy link
Member

Description of the desired feature

The spacing parameter of the rolling_window function controls the distance between the center of two adjacent windows.
Nevertheless, the docstring reads:

    spacing : float, tuple = (s_north, s_east), or None
        The window size in the South-North and West-East directions,
        respectively. A single value means that the size is equal in both
        directions.

Which is very confusing, given that the size parameter is the ones that controls the size of the windows.

We should fix the documentation so it reflects the actual role of the spacing parameter.

Are you willing to help implement and maintain this feature? Yes

@santisoler santisoler added documentation Improvements or additions to documentation good first issue Good for newcomers (doesn’t require deep knowledge of the project) help wanted labels May 11, 2021
@leouieda leouieda added this to the v2.0.0 milestone Aug 25, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers (doesn’t require deep knowledge of the project)
Projects
None yet
Development

No branches or pull requests

2 participants