docs: give the WDL quickstart example a version and test it - #5566
Merged
adamnovak merged 1 commit intoAug 20, 2026
Merged
Conversation
The example was written in draft-2 style without a version line, so toil-wdl-runner refused to run it. Move it into src/toil/test/docs/scripts, port it to WDL 1.0 and include it from the docs so the quickstart and the tested file cannot drift apart. Signed-off-by: vshulcz <vshulcz@gmail.com>
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
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.
Changelog Entry
To be copied to the draft changelog by merger:
Description
Fixes #5534.
The WDL in the quickstart has no
version, so it is parsed as draft-2 andtoil-wdl-runnerfails on it:The inputs JSON also addresses the task input directly (
write_simple_file.write_file.message), which does not bind.This ports the example to WDL 1.0 (
inputsections,~{}placeholder, the call passingmessagethrough), so the inputs file useswrite_simple_file.message.To keep the docs and a tested file from drifting apart, the example now lives in
src/toil/test/docs/scripts/next to the other documentation examples and is pulled intoquickStart.rstwithliteralinclude.MANIFEST.inalready ships that directory.test_documentation_quickstartinwdltoil_test.pyruns it the same waytest_MD5sumruns its workflow.Verified locally on an Apple Silicon macOS host with Docker:
I left
make formatalone:black --checkalready reportswdltoil_test.pyas unformatted on unmodifiedmasterhere, so running it would bury this change in unrelated reformatting.