Add optional 'plot' dependencies and update installation instructions in README #4
Conversation
WalkthroughThe pull request introduces optional plotting capabilities to the library by updating the Changes
Poem
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (1)
README.md (1)
69-69: Consider clarifying the plot extras requirementThe current wording could be more explicit about the required dependencies.
Consider this revision:
-Or use built-in methods to generate charts that highlight detection points - you must have installed statprocon with the plot extra: +Or use built-in methods to generate charts that highlight detection points (requires matplotlib and pandas via `pip install statprocon[plot]`):
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
⛔ Files ignored due to path filters (1)
uv.lockis excluded by!**/*.lock
📒 Files selected for processing (2)
README.md(2 hunks)pyproject.toml(1 hunks)
🔇 Additional comments (1)
README.md (1)
16-19: LGTM! Clear installation instructions for optional dependencies.The installation instructions for plot extras are clear and follow standard pip syntax.
| [project.optional-dependencies] | ||
| plot = [ | ||
| "matplotlib>=3.9.0", | ||
| "pandas>=2.0.0", | ||
| ] |
There was a problem hiding this comment.
Fix matplotlib version constraint
The specified version matplotlib>=3.9.0 is incorrect as version 3.9.0 doesn't exist yet. The latest stable version is 3.8.2.
Apply this diff to fix the version constraint:
[project.optional-dependencies]
plot = [
- "matplotlib>=3.9.0",
+ "matplotlib>=3.8.0",
"pandas>=2.0.0",
]📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| [project.optional-dependencies] | |
| plot = [ | |
| "matplotlib>=3.9.0", | |
| "pandas>=2.0.0", | |
| ] | |
| [project.optional-dependencies] | |
| plot = [ | |
| "matplotlib>=3.8.0", | |
| "pandas>=2.0.0", | |
| ] |
Include optional dependencies for plotting capabilities and clarify installation instructions in the README.
Summary by CodeRabbit
Documentation
Dependencies