docs: update docstrings for consistency with index-type generalization - #215
Merged
Conversation
- Fix detect_trends.py: timestamps → dates, segmenets → segments - Fix segments_refine/trend_classify.py: Series DataFrame → Time series DataFrame - Fix segments_refine/gradual_expand_contract.py: Series DataFrame → Time series DataFrame - Fix segments_get.py: Series DataFrame → Time series DataFrame - Update conftest.py docstring to mention numeric types (int, float) in addition to str/Timestamp
github-actions
Bot
requested review from
ChrisMarsden833
and removed request for
RussellSB
July 9, 2026 06:41
Contributor
Author
|
📚 Docs preview removed The docs preview for this PR has been cleaned up. |
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
ChrisMarsden833
approved these changes
Jul 25, 2026
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
This PR updates docstrings for consistency with the index-type generalization:
All tests pass after these changes.