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: update FAQ - recommend ensure function for failing on empty output #2910

Merged
merged 1 commit into from
Jun 10, 2024

Conversation

NelisDrost
Copy link
Contributor

Update the FAQ entry 'How do I make my rule fail if an output file is empty?' to point the user to the ensure(... , non_empty=True) function documentation.

Please check that the :ref: link (intended to point to https://snakemake.readthedocs.io/en/stable/snakefiles/rules.html#ensuring-output-file-properties-like-non-emptyness-or-checksum-compliance) is correct - I'm not familiar enough with sphinx to be 100% confident.

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

Copy link

sonarcloud bot commented Jun 9, 2024

Quality Gate Passed Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
No data about Coverage
No data about Duplication

See analysis details on SonarCloud

@NelisDrost NelisDrost changed the title Update FAQ - recommend ensure function for failing on empty output docs: update FAQ - recommend ensure function for failing on empty output Jun 9, 2024
@johanneskoester johanneskoester enabled auto-merge (squash) June 10, 2024 12:06
@johanneskoester
Copy link
Contributor

Thank you!

@johanneskoester johanneskoester merged commit b035071 into snakemake:main Jun 10, 2024
4 of 5 checks passed
johanneskoester pushed a commit that referenced this pull request Jun 11, 2024
🤖 I have created a release *beep* *boop*
---


##
[8.14.0](v8.13.0...v8.14.0)
(2024-06-11)


### Features

* add flag to mark files where path should not be modified
([#2888](#2888))
([d142b46](d142b46))
* support per rule shell exec setting via resources
([#2862](#2862))
([ab8d2dd](ab8d2dd))


### Documentation

* update FAQ - recommend ensure function for failing on empty output
([#2910](#2910))
([b035071](b035071))

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

None yet

2 participants