docs: fix #2698 #2714
Merged
docs: fix #2698 #2714
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
- removed `--cluster` paragraphs in tutorial - introduced link to SLURM executor docs and snakemake-profiles
re-shuffeled description on MPI usage, introduced links to SLURM executor plugin and snakemake-profiles
|
PS this PR addresses issue #2698 PPS I just hoped to get my way with the semantic commits ... |
|
At #2698 it has been commented that the API docs are missing, too. Not sure: Have these been auto-generated in the past @johanneskoester ? |
|
Yes, they are auto-generated. They are also there, but need some polishing: https://snakemake-api.readthedocs.io/en/stable/ And a link from the main docs as well. |
johanneskoester
approved these changes
Feb 24, 2024
|
Please format your code with black: |
|
johanneskoester
pushed a commit
that referenced
this pull request
Feb 24, 2024
🤖 I have created a release *beep* *boop* --- ## [8.5.1](v8.5.0...v8.5.1) (2024-02-24) ### Documentation * api docs polishing ([58a6a13](58a6a13)) * fix [#2698](#2698) ([#2714](#2714)) ([508080b](508080b)) --- 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
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
"Just" a documentation update:
--clusterreferences in the tutorial sectionReferences to SLURM Executor Plugin and snakemake-profiles in both changed paragraphs.
@johanneskoester today, I am not particularly good with words, but I hope its ok-ish.