Docstring examples #7881
Merged
Docstring examples #7881
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
TomNicholas
reviewed
May 31, 2023
TomNicholas
reviewed
May 31, 2023
TomNicholas
reviewed
May 31, 2023
TomNicholas
reviewed
May 31, 2023
xarray/core/dataset.py
Outdated
| } | ||
| ) | ||
|
|
||
| argmin_indices = dataset.argmin(dim='student') |
There was a problem hiding this comment.
Can add text explaining this
Can also feed the resulting indexes back in to .isel (that's why this argmin method exists)
Might be good to think of other example datasets for which you would be really interested in the index.
TomNicholas
requested changes
Jun 24, 2023
There was a problem hiding this comment.
Thanks @harshitha1201 - some changes needed here still before we can merge this.
TomNicholas
reviewed
Jun 30, 2023
TomNicholas
reviewed
Jun 30, 2023
TomNicholas
reviewed
Jun 30, 2023
TomNicholas
reviewed
Jul 3, 2023
TomNicholas
reviewed
Jul 3, 2023
TomNicholas
reviewed
Jul 3, 2023
TomNicholas
reviewed
Jul 3, 2023
TomNicholas
reviewed
Jul 3, 2023
TomNicholas
reviewed
Jul 3, 2023
Co-authored-by: Tom Nicholas <thomas.nicholas@columbia.edu>
TomNicholas
approved these changes
Jul 3, 2023
There was a problem hiding this comment.
Looks great! Thank you @harshitha1201 !
The two final (easy) things to do are:
- Merge recent changes from
maininto this branch (you can do that locally or by clicking the button on this PR), - Add a short note to
doc/whats-new.rstdescribing what you changed. Just something like "Added examples to docstrings ofDataset.isel,Dataset.argmin..., by Harshitha Diddidge". You should copy the format of other entries in the whatsnew file, including the number of this pull request. Also you can format the names of the methods you changes like this:py:meth:`Dataset.isel`
|
Thanks @harshitha1201 Nice work! |
dcherian
added a commit
to dcherian/xarray
that referenced
this pull request
Jul 16, 2023
* main: Remove hue_style from plot1d docstring (pydata#7925) Add new what's new section (pydata#7986) Release summary for v2023.07.0 (pydata#7979) Improve explanation in example "Working with Multidimensional Coordinates" (pydata#7984) Fix typo in zarr.py (pydata#7983) Examples added to docstrings (pydata#7936) [pre-commit.ci] pre-commit autoupdate (pydata#7973) Skip broken tests on python 3.11 and windows (pydata#7972) Use another repository for upstream testing (pydata#7970) Move absolute path finder from open_mfdataset to own function (pydata#7968) ensure no forward slashes in names for HDF5-based backends (pydata#7953) Chunked array docs (pydata#7951) [pre-commit.ci] pre-commit autoupdate (pydata#7959) manually unshallow the repository on RTD (pydata#7961) Update minimum version of typing extensions in pre-commit (pydata#7960) Docstring examples (pydata#7881)
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Added docstring examples to some string methods (#6793)
[ ]
Closes #xxxx[ ]Tests added
[ ]User visible changes (including notable bug fixes) are documented in whats-new.rst
[ ]
New functions/methods are listed in api.rst