-
Notifications
You must be signed in to change notification settings - Fork 4
fix: fix misleading CLI help text #76
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
📝 WalkthroughWalkthroughThe changes update descriptive text and user-facing labels in a plugin registry module by replacing references to "executor settings" with "plugin settings." Only docstrings and string literals were modified, with no alterations to logic, control flow, or public interfaces. Changes
Sequence Diagram(s)No sequence diagram generated as the changes are limited to docstrings and string literals without impacting logic or control flow. ✨ Finishing Touches
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. 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 (
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 0
🧹 Nitpick comments (2)
src/snakemake_interface_common/plugin_registry/plugin.py (2)
98-100
: Add terminating period for docstring consistencyNearly all one-liner docstrings in this module end with a period.
Keeping the style uniform improves readability.-"""Determine if a plugin defines custom settings""" +"""Determine if a plugin defines custom settings."""
145-155
: Keep terminology consistent: replace remaining “ExecutorSettings”The group heading now says “plugin settings”, but the two
InvalidPluginException
messages still refer to “ExecutorSettings”, which can confuse plugin authors.
Updating the wording keeps the CLI and error output aligned.- self.name, "Fields of ExecutorSettings must have a help string." + self.name, "Fields of plugin settings must have a help string." ... - self.name, "Fields of ExecutorSettings must have a default value." + self.name, "Fields of plugin settings must have a default value."
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
⛔ Files ignored due to path filters (1)
pyproject.toml
is excluded by!pyproject.toml
📒 Files selected for processing (1)
src/snakemake_interface_common/plugin_registry/plugin.py
(2 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
**/*.py
Instructions used from:
Sources:
⚙️ CodeRabbit Configuration File
🤖 I have created a release *beep* *boop* --- ## [1.20.2](v1.20.1...v1.20.2) (2025-07-18) ### Bug Fixes * fix misleading CLI help text ([#76](#76)) ([2066947](2066947)) --- This PR was generated with [Release Please](https://github.com/googleapis/release-please). See [documentation](https://github.com/googleapis/release-please#release-please). Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Summary by CodeRabbit