Skip to content

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

Merged
merged 2 commits into from
Jul 18, 2025
Merged

fix: fix misleading CLI help text #76

merged 2 commits into from
Jul 18, 2025

Conversation

johanneskoester
Copy link
Contributor

@johanneskoester johanneskoester commented Jul 18, 2025

Summary by CodeRabbit

  • Style
    • Updated user-facing labels and descriptions to refer to "plugin settings" instead of "executor settings" for improved clarity.

Copy link

coderabbitai bot commented Jul 18, 2025

📝 Walkthrough

Walkthrough

The 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

File Change Summary
src/snakemake_interface_common/plugin_registry/plugin.py Updated docstring and string literals to use "plugin settings" instead of "executor settings."

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
  • 📝 Generate Docstrings

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.

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Explain this complex logic.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai explain this code block.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and explain its main purpose.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need 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)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link

@coderabbitai coderabbitai bot left a 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 consistency

Nearly 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

📥 Commits

Reviewing files that changed from the base of the PR and between 2b5a970 and 8d417f0.

⛔ 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

@johanneskoester johanneskoester merged commit 2066947 into main Jul 18, 2025
5 checks passed
@johanneskoester johanneskoester deleted the fix/deps branch July 18, 2025 12:08
johanneskoester pushed a commit that referenced this pull request Jul 18, 2025
🤖 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>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant