-
-
Notifications
You must be signed in to change notification settings - Fork 1.1k
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
Docstring and documentation improvement for the Dataset class #8973
Merged
Commits on Apr 25, 2024
-
Updates the example in the doc-string for the Dataset class to be cle…
…arer. The example in the doc-string of the `Dataset` class prior to this commit uses an example array whose size is `2 x 2 x 3` with the first two dimensions labeled `"x"` and `"y"` and the final dimension labeled `"time"`. This was confusing due to the fact that `"x"` and `"y"` are just arbitrary names for these axes and that no reason is given for the data to be organized in a `2x2x3` array instead of a `2x2` matrix. This commit clarifies the example. See issue pydata#8970 for more information.
Configuration menu - View commit details
-
Copy full SHA for ce6b158 - Browse repository at this point
Copy the full SHA ce6b158View commit details -
Updates the documentation of the Dataset class to have clearer examples.
These changes to the documentation bring it into alignment with the changes to the `Dataset` doc-string committed previously. See issue pydata#8970 for more information.
Configuration menu - View commit details
-
Copy full SHA for 2b72c96 - Browse repository at this point
Copy the full SHA 2b72c96View commit details -
[pre-commit.ci] auto fixes from pre-commit.com hooks
for more information, see https://pre-commit.ci
Configuration menu - View commit details
-
Copy full SHA for 6454852 - Browse repository at this point
Copy the full SHA 6454852View commit details -
Configuration menu - View commit details
-
Copy full SHA for 2280ba4 - Browse repository at this point
Copy the full SHA 2280ba4View commit details -
Configuration menu - View commit details
-
Copy full SHA for 2a03e91 - Browse repository at this point
Copy the full SHA 2a03e91View commit details -
Configuration menu - View commit details
-
Copy full SHA for dfb308a - Browse repository at this point
Copy the full SHA dfb308aView commit details -
Configuration menu - View commit details
-
Copy full SHA for 1ca80ba - Browse repository at this point
Copy the full SHA 1ca80baView commit details
Commits on Apr 29, 2024
-
Configuration menu - View commit details
-
Copy full SHA for b92c52d - Browse repository at this point
Copy the full SHA b92c52dView commit details
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.