Docstrings examples for string methods #7669
Merged
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
for more information, see https://pre-commit.ci
for more information, see https://pre-commit.ci
added 2 commits
March 24, 2023 16:54
Solves the incosistent whitespace error
…array into docstring-examples
for more information, see https://pre-commit.ci
headtr1ck
approved these changes
Mar 29, 2023
xarray/core/accessor_str.py
Outdated
| Dimensions without coordinates: x | ||
|
|
||
| Using regex: | ||
| >>> pat = "jj\\w+" |
There was a problem hiding this comment.
Maybe we could come up with a more interesting example.
Maybe add a number after one of the "jj" in the DataArray, and then look for "jj\d"?
But this version is already a good start.
There was a problem hiding this comment.
Will do, thank you!
headtr1ck
approved these changes
Mar 29, 2023
xarray/core/accessor_str.py
Outdated
| Dimensions without coordinates: x | ||
|
|
||
| Using regex: | ||
| >>> pat = "jj\\w+" |
There was a problem hiding this comment.
It seems that the build system does not like the double escaped strings.
No idea how to solve this though, maybe we could use a raw string pat = r"jj\w+"?
There was a problem hiding this comment.
I've tried using the raw string but I had to also escape the backslash pat = r"jj\\w+" for the warning to disappear.
There was a problem hiding this comment.
Ok, then I think this is a bug of our docstring parser.
The problem is that if we use this example, it will pass the CI pipeline, but it will be actually wrong?
Or how does this render in the webpage?
Maybe we can construct an example without backslashes?
There was a problem hiding this comment.
Yeah! I think I can just use [a-z] or [0-9].
…array into docstring-examples
for more information, see https://pre-commit.ci
keewis
reviewed
Mar 30, 2023
There was a problem hiding this comment.
I've got a few more suggestions, but otherwise this does look good to me.
The failing docs CI is caused by pydata-sphinx-theme=0.13.2 being incompatible with sphinx-book-theme=1.0.0. I think we can pin pydata-sphinx-theme!=0.13.2 until they fixed that (though maybe that should be done in a new PR).
…array into docstring-examples
for more information, see https://pre-commit.ci
Just saw this comment. I have opened #7703 for this |
|
The docs build failure is real, from some rst formatting error |
I'll fix it! |
|
Thanks @remigathoni great PR! |
dcherian
added a commit
to dcherian/xarray
that referenced
this pull request
Apr 25, 2023
* main: Bump codecov/codecov-action from 3.1.2 to 3.1.3 (pydata#7781) Fix whats-new [skip-ci] dev whats-new (pydata#7775) [skip-ci] Release 2023.04.2 (pydata#7774) Fix groupby_bins when labels are specified (pydata#7769) Docstrings examples for string methods (pydata#7669) Add dev whats-new Add benchmark against latest release on main. (pydata#7753)
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.
Adds docstring examples to some string methods (#6793 ).
Please let me know if there are any changes I need to make. Thank you!