Skip to content
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

docs: checkpoint documentation #1562

Merged
merged 4 commits into from Apr 25, 2022

Conversation

gregdenay
Copy link
Contributor

@gregdenay gregdenay commented Apr 4, 2022

Description

This is an attempt at slightly rewritting the documentation of the checkpoint keyword to make its use easier to understand.
Adding one very simple example of creating an arbitrary number of files before deirect aggregation, on which the second existing example is then built.
Requirement to use directory vs. filenames as output in this case is made clearer.

Feedback welcome!

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

@gregdenay gregdenay changed the title Checkpoint documentation docs: checkpoint documentation Apr 4, 2022
@gregdenay gregdenay marked this pull request as ready for review Apr 4, 2022
@gregdenay gregdenay requested a review from johanneskoester as a code owner Apr 4, 2022
docs/snakefiles/rules.rst Outdated Show resolved Hide resolved
docs/snakefiles/rules.rst Outdated Show resolved Hide resolved
@johanneskoester johanneskoester merged commit 4cbfb47 into snakemake:main Apr 25, 2022
2 of 3 checks passed
@sonarcloud
Copy link

sonarcloud bot commented Apr 25, 2022

Kudos, SonarCloud Quality Gate passed!    Quality Gate passed

Bug A 0 Bugs
Vulnerability A 0 Vulnerabilities
Security Hotspot A 0 Security Hotspots
Code Smell A 0 Code Smells

No Coverage information No Coverage information
No Duplication information No Duplication information

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.

None yet

2 participants