DOC: Fixing EX01 - Added examples #54254
Merged
Conversation
This file contains hidden or 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
pandas/core/indexers/objects.py
Outdated
| ... return start, end | ||
| >>> df = pd.DataFrame({"values": range(5)}) | ||
| >>> indexer = CustomIndexer(window_size=2) | ||
| >>> df.rolling(indexer).sum() # doctest: +SKIP |
There was a problem hiding this comment.
what was it complaining about? could you show the error please?
There was a problem hiding this comment.
+ /Users/dealeon/mambaforge/envs/pandas-dev/bin/ninja
[1/1] Generating write_version_file with a custom command
[1] 33979 segmentation fault ./scripts/validate_docstrings.py pandas.api.indexers.BaseIndexer```
There was a problem hiding this comment.
you need to update start inside the loop too (not just end)
|
/preview |
|
No preview found for PR #54254. Did the docs build complete? |
|
/preview |
|
Website preview of this PR available at: https://pandas.pydata.org/preview/54254/ |
|
It looks like failing tests are unrelated |
mroeschke
approved these changes
Jul 26, 2023
|
Thanks @DeaMariaLeon |
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.
Towards #37875
Notes:
On the web there are only 3 custom rolling windows:
BaseIndexer,FixedForwardWindowIndexerandVariableOffsetWindowIndexer. But there are more of them in the code. LikeExpandingIndexeretc..Added# doctest: +SKIPto the last line ofBaseIndexerbecausevalidate_docstrings.pywas complaining.I need to do \preview here as I was having a lot of issues with the html file made with Sphinx.
I'll open a separate PR to correct the User Guide on
BaseIndexer.