Skip to content

fix: missing quotes for the slurm comment #211

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 1 commit into from
Feb 14, 2025

Conversation

benjamin-lieser
Copy link
Contributor

@benjamin-lieser benjamin-lieser commented Feb 14, 2025

Snakemake does not correctly escape the comment it passes to slurm. When a wildcard contains for example a ( this will lead to errors.

Summary by CodeRabbit

Minor internal updates have been deployed to streamline how job submission commands are assembled. These refinements maintain the current functionality and user experience without introducing any visible changes.

  • Refactor
    • Enhanced internal handling of command formatting during job submissions to ensure consistency.

Copy link
Contributor

coderabbitai bot commented Feb 14, 2025

Walkthrough

This pull request updates the run_job method in the snakemake_executor_plugin_slurm/__init__.py file. The change replaces double quotes with single quotes for the --comment argument in the sbatch command. The modification is strictly cosmetic in nature and does not affect the underlying logic or control flow of the job submission process.

Changes

File Change Summary
snakemake_executor_plugin_slurm/init.py Modified the --comment argument in run_job: replaced double quotes with single quotes.

Possibly related PRs

Suggested reviewers

  • fgvieira

Poem

Hoppity-hop, I'm a coding bunny,
Tweaking quotes—oh, isn't it funny?
Single quotes guard our comment right,
Replacing doubles in the code's twilight.
A tiny change but a joyful sight,
🐇 Celebrating code with all my might!


📜 Recent review details

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 17d488b and e064b8e.

📒 Files selected for processing (1)
  • snakemake_executor_plugin_slurm/__init__.py (1 hunks)
✅ Files skipped from review due to trivial changes (1)
  • snakemake_executor_plugin_slurm/init.py

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?

❤️ 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.
    • Generate unit testing code for this file.
    • 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 generate unit testing code for this file.
    • @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 generate unit testing code.
    • @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.

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. (Beta)
  • @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.

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.

@benjamin-lieser benjamin-lieser changed the title Fix missing quotes for the slurm comment fix: missing quotes for the slurm comment Feb 14, 2025
@cmeesters cmeesters self-requested a review February 14, 2025 19:42
Copy link
Member

@cmeesters cmeesters left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

minor change - will prevent fails in case of syntax containing characters within wildcards

@cmeesters
Copy link
Member

@benjamin-lieser thank you for your contribution!

@cmeesters cmeesters merged commit 44f2e2b into snakemake:main Feb 14, 2025
5 of 7 checks passed
cmeesters pushed a commit that referenced this pull request Feb 14, 2025
🤖 I have created a release *beep* *boop*
---


##
[0.15.1](v0.15.0...v0.15.1)
(2025-02-14)


### Bug Fixes

* missing quotes for the slurm comment
([#211](#211))
([44f2e2b](44f2e2b))

---
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.

2 participants