docs: link cwl-docker-extract from CWL_SINGULARITY_CACHE help (#1537)#2289
Open
arimu1 wants to merge 2 commits into
Open
docs: link cwl-docker-extract from CWL_SINGULARITY_CACHE help (#1537)#2289arimu1 wants to merge 2 commits into
arimu1 wants to merge 2 commits into
Conversation
…-workflow-language#1537) Issue common-workflow-language#1537 asked to document CWL_SINGULARITY_CACHE and link to the cwl-utils "pull all referenced software container images" reference. The variable itself is now listed in the environment-variable table (shown in `cwltool --help` and the Sphinx CLI docs), but it did not point users at how to pre-populate the cache. Add a link to cwl-utils' cwl-docker-extract, using the existing [link=...] markup so it renders both as a terminal hyperlink and as a reStructuredText link in the generated docs. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
mr-c
requested changes
Jun 18, 2026
| f"[{bt}]dockerFile[/] images will also be searched for and stored here", | ||
| f"[{bt}]dockerFile[/] images will also be searched for and stored here. " | ||
| f"Images can be pre-pulled into this directory using " | ||
| f"[link=https://github.com/common-workflow-language/cwl-utils#pull-the-all-referenced-software-container-images]cwl-docker-extract[/] from cwl-utils", |
Member
There was a problem hiding this comment.
Probably better to link to https://pypi.org/project/cwl-utils/ or https://cwl-utils.readthedocs.io/en/latest/#cwl-docker-extract
…workflow-language#1537) Per review feedback, link to the stable cwl-utils documentation page (https://cwl-utils.readthedocs.io/en/latest/#cwl-docker-extract) instead of the GitHub README anchor.
Author
|
Good call — switched the link to the stable cwl-utils docs page: https://cwl-utils.readthedocs.io/en/latest/#cwl-docker-extract (confirmed the |
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.
Summary
Addresses #1537, which asked to document
CWL_SINGULARITY_CACHEand link to the cwl-utils Pull the all referenced software container images reference.The variable is now listed in the environment-variable table (introduced when the CLI groups were reorganized), so it appears in
cwltool --helpand the autogenerated Sphinx CLI docs. What was still missing is the second half of the request: pointing users at how to pre-populate that cache.Change
Extend the
CWL_SINGULARITY_CACHEentry incwltool/argparser.pyto link to cwl-utils'cwl-docker-extract, which pre-pulls all referenced container images into a directory. It uses the existing[link=...]markup (same as theORCIDentry), so it renders correctly in both outputs:cwltool --help(terminal hyperlink):Sphinx CLI docs (reStructuredText):
Verified the cwl-utils anchor still resolves, the parser still builds, and
black/flake8are clean. Docs-only string change. Once this lands, #1537 can be closed.This change was produced with the assistance of Claude Code (model: Claude Opus). It was reviewed by a human before submission.