Skip to content

docs: typo in the migration table breaking a pip install command#4024

Merged
johanneskoester merged 1 commit intosnakemake:mainfrom
SrPeter128:fix_typo_docs_migration_table
Mar 10, 2026
Merged

docs: typo in the migration table breaking a pip install command#4024
johanneskoester merged 1 commit intosnakemake:mainfrom
SrPeter128:fix_typo_docs_migration_table

Conversation

@SrPeter128
Copy link
Copy Markdown
Contributor

@SrPeter128 SrPeter128 commented Mar 10, 2026

This very very minor PR fixes a small typo in the table that lists differences in the interfaces between the versions. In the pip install description, the word “plugin” was omitted in the pip install command pip install snakemake-executor-plugin-cluster-generic.

Fix #3827

Summary by CodeRabbit

  • Documentation
    • Updated the recommended pip package name for the cluster-generic executor plugin in the migration guide.

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai bot commented Mar 10, 2026

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: c6a85382-f846-4224-b92d-56c8c5571594

📥 Commits

Reviewing files that changed from the base of the PR and between b88171c and 2c43321.

📒 Files selected for processing (1)
  • docs/getting_started/migration.rst

📝 Walkthrough

Walkthrough

Documentation correction updating the pip install package name from snakemake-executor-cluster-generic to snakemake-executor-plugin-cluster-generic in the migration guide to reflect the correct package naming convention.

Changes

Cohort / File(s) Summary
Documentation Update
docs/getting_started/migration.rst
Corrected pip package name for cluster-generic executor plugin from snakemake-executor-cluster-generic to snakemake-executor-plugin-cluster-generic.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Description check ⚠️ Warning The PR description does not follow the required template which includes a QC checklist section with items about test cases and documentation updates. Add the QC checklist section with checkboxes to confirm test case coverage and documentation updates have been addressed.
✅ Passed checks (4 passed)
Check name Status Explanation
Title check ✅ Passed The title accurately describes the change: a typo fix in the migration table documentation where 'plugin' was omitted from a pip install command.
Linked Issues check ✅ Passed The PR addresses issue #3827 by correcting the pip install command in the migration documentation from snakemake-executor-cluster-generic to snakemake-executor-plugin-cluster-generic.
Out of Scope Changes check ✅ Passed All changes are within scope: only a single-word correction ('plugin' added) in the migration documentation as required by issue #3827.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

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

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment

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 merged commit 66f9dda into snakemake:main Mar 10, 2026
112 of 113 checks passed
@SrPeter128 SrPeter128 deleted the fix_typo_docs_migration_table branch March 10, 2026 15:47
johanneskoester pushed a commit that referenced this pull request Mar 13, 2026
🤖 I have created a release *beep* *boop*
---


##
[9.17.0](v9.16.3...v9.17.0)
(2026-03-13)


### Features

* Allow storing snakemake metadata in files or databases
([#4012](#4012))
([dd75f31](dd75f31))
* Allow to specify comparison command per-unit test
([#3956](#3956))
([b88171c](b88171c))
* job table orderd topological when run is started
([#4018](#4018))
([75cf506](75cf506))
* lambda functions for priority in rules
([#3253](#3253))
([d2aa226](d2aa226))
* Make on... directive of modules accessible
([#4050](#4050))
([e9f2e1c](e9f2e1c))


### Bug Fixes

* adjust conda tests to not fail on apple silicon; fix
[#4040](#4040)
([#4049](#4049))
([f5b0142](f5b0142))
* allow "--containerize apptainer" to output apptainer format instead of
dockerfile ([#4030](#4030))
([f5cac30](f5cac30))
* apptainer command not recognized when singularity is absent
([#4010](#4010))
([b8162e2](b8162e2))
* capture stderr when tests fail
([#3995](#3995))
([97d74ba](97d74ba))
* **docs:** make Data-dependent conditional execution a complete example
([#4043](#4043))
([3a1d7f2](3a1d7f2))
* don't build the DAG when running unlock. Fixes
[#4000](#4000) and
[#198](#198)
([#4007](#4007))
([acf79fd](acf79fd))
* Ensure pixi tasks may be run as advertised
([#4046](#4046))
([88253c2](88253c2))
* fix checkpoint handling corner cases
([#3870](#3870) and
[#3559](#3559))
([#4015](#4015))
([63f4257](63f4257))
* issue 3642
([#4054](#4054))
([76e6fc2](76e6fc2))
* issue 3815
([#4026](#4026))
([b0eec96](b0eec96))
* logging None in shellcmd context causes error
([#4064](#4064))
([d0652cd](d0652cd))
* lookup function returns default value for empty DataFrame queries
([#4056](#4056))
([f71de97](f71de97))
* make `cache: omit-software` a rule specific property
([#4085](#4085))
([034a9e7](034a9e7))
* reduce number of tests leaving temporary files behind
([#4033](#4033))
([a3a1c97](a3a1c97))
* regression in dynamic resource handling
([#4038](#4038))
([f2c554a](f2c554a))
* somewhat shorter announce message
([#4080](#4080))
([57efc71](57efc71))


### Performance Improvements

* switch reretry with tenacity; decouple container classes (with Python
3.7 compat for old scripts) from rest of the codebase (enabling moving
to newer python versions)
([#4032](#4032))
([ffb19e7](ffb19e7))


### Documentation

* Add AI-assisted contributions policy to contributing guidelines
([#4051](#4051))
([dd70526](dd70526))
* **codebase:** Update & simplify plugin architecture section
([#4052](#4052))
([176cf63](176cf63))
* Correct workflow.source_path() description in documentation
([#4036](#4036))
([45883c5](45883c5))
* fixed wrong code example for collect() function
([#4037](#4037))
([5c85ed8](5c85ed8))
* Minor docs improvements
([#4089](#4089))
([29ea226](29ea226))
* switch to sphinx_design for tabs
([#3976](#3976))
([9674614](9674614))
* typo in the migration table breaking a pip install command
([#4024](#4024))
([66f9dda](66f9dda))

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

migration table plugin doc

2 participants