docs: clarify continuously updated input section#3219
Merged
johanneskoester merged 1 commit intosnakemake:mainfrom Nov 26, 2024
Merged
docs: clarify continuously updated input section#3219johanneskoester merged 1 commit intosnakemake:mainfrom
johanneskoester merged 1 commit intosnakemake:mainfrom
Conversation
Contributor
📝 WalkthroughWalkthroughThe pull request updates the Changes
Possibly related PRs
Suggested reviewers
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
|
Contributor
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Outside diff range and nitpick comments (4)
docs/snakefiles/rules.rst (4)
Line range hint
2917-2934: Consider enhancing the documentation with additional details.The documentation could be improved by:
- Adding more examples of use cases beyond streaming data analysis (e.g., real-time monitoring, log processing)
- Explicitly mentioning that the queue must be thread-safe
- Adding a note about potential performance implications
2936-2936: Consider adding more details about the finish sentinel behavior.The documentation could be enhanced by:
- Explaining what happens if the sentinel is never received (e.g., timeout behavior)
- Clarifying whether the sentinel can be any Python object or if there are restrictions
Line range hint
2937-2975: Consider enhancing the example code with additional documentation.The example could be improved by:
- Adding comments explaining the purpose of the error handling (KeyboardInterrupt, SystemExit)
- Showing how to properly clean up resources (e.g., joining threads) when the workflow is interrupted
- Adding a note about thread safety considerations
Line range hint
2977-3037: Consider adding safety considerations for file updates.The documentation could be enhanced with:
- Warning about potential race conditions when multiple jobs update the same file
- Explaining any limitations or edge cases (e.g., what happens if the file doesn't exist)
- Best practices for using update/before_update in distributed environments
johanneskoester
pushed a commit
that referenced
this pull request
Nov 27, 2024
🤖 I have created a release *beep* *boop* --- ## [8.25.4](v8.25.3...v8.25.4) (2024-11-27) ### Bug Fixes * clean env vars in apptainer ([#3199](#3199)) ([76d5329](76d5329)) * ensure that intermediate files in job groups do not cause spurious mtime errors when checking for consistency with output files ([#3220](#3220)) ([4ba2bdf](4ba2bdf)) * Remove incomplete marker also when drop-metadata is active ([#3215](#3215)) ([a4f2e5c](a4f2e5c)) * Remove incomplete marker for job finished only after metadata is written ([#3197](#3197)) ([6567e5f](6567e5f)) * Support versioned URLs in Asset class and fix missing versions in Snakemake report ([#3203](#3203)) ([f086f6c](f086f6c)) * update rust-script usage to recent version (v0.35.0) [#3183](#3183) ([#3208](#3208)) ([43885d7](43885d7)) ### Documentation * clarify continuously updated input section ([#3219](#3219)) ([72a6994](72a6994)) * Fix typo in CHANGELOG.md ([#3198](#3198)) ([0e445ed](0e445ed)) * refer to Merkle trees instead of "blockchain" in caching.rst ([#3216](#3216)) ([282e5d9](282e5d9)) * remove twitter in favor of bluesky and mastodon ([#3217](#3217)) ([231c6df](231c6df)) * use "dictionary" not "array" wording in config docs ([#3156](#3156)) ([17aed41](17aed41)) --- 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>
2 tasks
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
As discussed on Discord
Summary by CodeRabbit