Skip to content

docs: remove duplicated resources attribute in rules.rst#4190

Merged
johanneskoester merged 2 commits into
snakemake:mainfrom
kinow:patch-1
May 29, 2026
Merged

docs: remove duplicated resources attribute in rules.rst#4190
johanneskoester merged 2 commits into
snakemake:mainfrom
kinow:patch-1

Conversation

@kinow

@kinow kinow commented May 10, 2026 •
edited by coderabbitai Bot
Loading

Copy link
Copy Markdown
Contributor

Hi, I needed an example about MPI + Snakemake for my master's thesis, and while reading the example code I noticed a duplicated resources line. I am not very fluent in Snakemake, so I checked the other examples where there's only one line with the resources statement.

QC

  • The PR contains a test case for the changes or the changes are already covered by an existing test case.
  • The documentation (docs/) is updated to reflect the changes or this is not necessary (e.g. if the change does neither modify the language nor the behavior or functionalities of Snakemake).
  • I, as a human being, have checked each line of code in this pull request

AI-assistance disclosure

I used AI assistance for:

  • Code generation (e.g., when writing an implementation or fixing a bug)
  • Test/benchmark generation
  • Documentation (including examples)
  • Research and understanding

Summary by CodeRabbit

  • Documentation
    • Clarified the MPI support example by explicitly specifying resource values (tasks and MPI launcher), so resource placeholders in the example are resolved and the guidance is clearer and more complete for users.

Review Change Stack

@kinow kinow requested a review from johanneskoester as a code owner May 10, 2026 13:56
@coderabbitai

coderabbitai Bot commented May 10, 2026 •
edited
Loading

Copy link
Copy Markdown
Contributor

Caution

Review failed

The pull request is closed.

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 4b8eeff4-0e4f-4b17-b120-2f316a303fee

📥 Commits

Reviewing files that changed from the base of the PR and between 334a3ac and 8806e6c.

📒 Files selected for processing (1)
  • docs/snakefiles/rules.rst
📝 Walkthrough

Walkthrough

The MPI support documentation example for the calc_pi rule is updated to explicitly define the tasks and mpi resource values in the resources: section that are referenced via placeholders in the shell command.

Changes

MPI Documentation Example

Layer / File(s) Summary
Documentation Update
docs/snakefiles/rules.rst		 The MPI example rule calc_pi now includes concrete resources fields (tasks and mpi) so the referenced placeholders in the shell command are defined.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Title check ⚠️ Warning The title states the change removes a duplicated resources attribute, but the summary indicates it actually updates/completes the resources section with explicit task and mpi definitions. Revise the title to accurately reflect that the resources section was updated to explicitly define tasks and mpi values, not simply that a duplicate was removed.
✅ Passed checks (4 passed)
Check name Status Explanation
Description check ✅ Passed The description is mostly complete with QC checklist and AI-assistance disclosure, though the explanation of the actual issue could be more precise.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

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

Comment @coderabbitai help to get the list of available commands and usage tips.

@johanneskoester johanneskoester changed the title Remove duplicated resources attribute in rules.rst docs: remove duplicated resources attribute in rules.rst May 29, 2026
@johanneskoester johanneskoester merged commit 6c8ecdd into snakemake:main May 29, 2026
55 of 57 checks passed
@snakemake-bot snakemake-bot mentioned this pull request May 29, 2026
Merged
@kinow kinow deleted the patch-1 branch May 29, 2026 13:37
johanneskoester pushed a commit that referenced this pull request May 29, 2026
@snakemake-bot
chore(main): release 9.21.1 (#4200)
5b5482e 
🤖 I have created a release *beep* *boop*
---


##
[9.21.1](v9.21.0...v9.21.1)
(2026-05-29)


### Bug Fixes

* add default json function to benchmarks
([#4128](#4128))
([41fab22](41fab22))
* do not rerun when checkpoint job missing but downstream file exists
([#4124](#4124))
([a060b93](a060b93))
* ensure that error logs contain all available details
([#4183](#4183))
([74a86e9](74a86e9))
* handle missing pss attribute in benchmark on Windows
([#4160](#4160))
([da52080](da52080))
* implement Resources.setdefault
([#3968](#3968))
([2413e99](2413e99))
* reporting remote nodes number
([#3978](#3978))
([8c534f0](8c534f0))
* resolve pathvars before constructing storage queries
([#3969](#3969))
([bd15237](bd15237))
* storage temp() file cleanup with RemoteProvider
([#4189](#4189))
([898bad1](898bad1))
* tolerate FileNotFoundError in drop_iocache
([#4153](#4153))
([#4191](#4191))
([ce26b28](ce26b28))


### Documentation

* Added guide on debugging workflows
([#4029](#4029))
([3d052ae](3d052ae))
* **cli:** Remove broken ref bold markup
([#4204](#4204))
([1200ebf](1200ebf))
* remove duplicated resources attribute in rules.rst
([#4190](#4190))
([6c8ecdd](6c8ecdd))
* **rules:** Update script type hint advice
([#4193](#4193))
([6108712](6108712))

---
This PR was generated with [Release
Please](https://github.com/googleapis/release-please). See
[documentation](https://github.com/googleapis/release-please#release-please).
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@johanneskoester johanneskoester johanneskoester approved these changes

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@kinow @johanneskoester