DOCS-2791 Fix dxda help strings#103
Open
dx-janc wants to merge 4 commits into
Open
Conversation
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.
Summary
Fix the Download Agent CLI help output so the generated help strings are clearer and match the actual command behavior.
This keeps the scope limited to help text and help rendering. It does not add tests or change command behavior.
What changed
inspect -husage line so it no longer shows thedownloadusage.inspectsynopsis with clearer integrity-validation wording.inspectflag description to sayvalidating filesinstead ofdownloading files.commands -h,flags -h,progress -h, andversion -h.Before and after examples
dx-download-agent -hBefore:
After:
dx-download-agent commands -hBefore:
After:
dx-download-agent flags -hBefore:
After:
dx-download-agent download -hBefore:
After:
dx-download-agent inspect -hBefore:
After:
dx-download-agent progress -hBefore:
After:
dx-download-agent version -hBefore:
After:
Validation
masterbinaries locally and compared the main help-producing commands side by side.go test ./...in an isolated HOME/PATH environment to avoid local DNAnexus config leaking into existing tests.