docs: Change sha256 checksum in docs to more realistic example#2987
docs: Change sha256 checksum in docs to more realistic example#2987johanneskoester merged 2 commits intosnakemake:mainfrom
Conversation
It is strange/confusing that the example checksum in the docs does not look like a sha256. I've changed it to a real hexdigest (the sha256 of the content b"test", as was also used in the tests: https://github.com/snakemake/snakemake/blob/e8735c1477a2a82110757ba86bbd1ccbcaf327ba/tests/test_ensure/Snakefile#L17-L24 ref: https://stackoverflow.com/questions/78801757/what-is-the-encoding-of-this-sha256-hash-in-the-snakemake-documentation
|
Thank you for spotting that and suggesting a fix. However, the current testsuite fails on an unrelated issue, which I think is caused by numpy 2. The last successful run of the test suite still ran numpy 1.26. I will try to find in which spots we need to fix the numpy version to <2 in order to get the original tests running again. You can then pull in those changes to get this PR up and running again. |
|
Work in progress, but there are more issues with the tests, follow #2988 for more info |
|
tests fixed. |
|
thanks! |
|
|
Warning Rate limit exceeded@johanneskoester has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 25 minutes and 5 seconds before requesting another review. How to resolve this issue?After the wait time has elapsed, a review can be triggered using the We recommend that you space out your commits to avoid hitting the rate limit. How do rate limits work?CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout. Please see our FAQ for further information. 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 as PR comments)
Additionally, you can add CodeRabbit Configuration File (
|
🤖 I have created a release *beep* *boop* --- ## [8.17.0](v8.16.0...v8.17.0) (2024-08-13) ### Features * fix job rate limiting with --max-jobs-per-second and introduce the more flexible --max-jobs-per-timespan ([#3010](#3010)) ([9c31257](9c31257)) ### Bug Fixes * Allow hyphens in config keys given on the command line. ([#2998](#2998)) ([b70c0db](b70c0db)) * allowing trailing '+' in name patterns ([#3002](#3002)) ([59150d3](59150d3)) * print message if not yet enough resources for executing further jobs ([b8df036](b8df036)) * unawaited coroutine sanitize_local_storage_copies ([#2972](#2972)) ([715c572](715c572)) ### Documentation * Change sha256 checksum in docs to more realistic example ([#2987](#2987)) ([16a5cf2](16a5cf2)) * Make it more clear that the cluster commands now require a plugin ([#2976](#2976)) ([74134cf](74134cf)) * Update installation.rst to recommend Miniforge instead of Mambaforge ([#2975](#2975)) ([0fc7619](0fc7619)) * use plain monospace font instead of theme default that changes >= into ≥ ([cc17fc1](cc17fc1)) --- 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>



It is strange/confusing that the example checksum in the docs does not look like a sha256.
I've changed it to a real hexdigest (the sha256 of the content b"test", as was also used in the tests:
snakemake/tests/test_ensure/Snakefile
Lines 17 to 24 in e8735c1
ref: https://stackoverflow.com/questions/78801757/what-is-the-encoding-of-this-sha256-hash-in-the-snakemake-documentation