no-copy CLI example #3438
no-copy CLI example #3438
Conversation
Codecov Report
@@ Coverage Diff @@
## master #3438 +/- ##
==========================================
+ Coverage 28.29% 36.10% +7.80%
==========================================
Files 641 686 +45
Lines 25936 29981 +4045
Branches 4418 4418
==========================================
+ Hits 7339 10825 +3486
- Misses 17425 17984 +559
Partials 1172 1172
Flags with carried forward coverage won't be shown. Click here to find out more.
... and 50 files with indirect coverage changes 📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more |
| @@ -479,6 +503,11 @@ def create_parser(): | |||
| action="store_true", | |||
| help="Do not copy data. Package manifest entries will reference the data at the original location.", | |||
| ) | |||
| optional_args.add_argument( | |||
| "--detailed_help", | |||
There was a problem hiding this comment.
Why not be consistent with other flags?
| "--detailed_help", | |
| "--detailed-help", |
There was a problem hiding this comment.
That would be ideal, but the catalog command already set it the other way, and changing it now doesn't seem worth the inconsistency/breakage.
catalog_p.add_argument(
"--detailed_help",
help="Display detailed information about this command and then exit",
action="store_true",
)
There was a problem hiding this comment.
I think you could make requested change given #3439 is merged.
| @@ -138,7 +138,7 @@ optional arguments: | |||
| ``` | |||
| usage: quilt3 push --dir DIR [-h] [--registry REGISTRY] [--dest DEST] | |||
| [--message MESSAGE] [--meta META] [--workflow WORKFLOW] | |||
| [--force] [--dedupe] [--no-copy] | |||
| [--force] [--dedupe] [--no-copy] [--detailed_help] | |||
There was a problem hiding this comment.
Why not just make -h work like this instead of adding another command?
There was a problem hiding this comment.
detailed_help is the existing mechanism for adding documentation to the published web docs.
| """ | ||
| Push a Quilt package with `name` to the specified (or default) registry. | ||
|
|
||
| If detailed_help=True, display detailed information about the `quilt3 push` command and then exit |
There was a problem hiding this comment.
| If detailed_help=True, display detailed information about the `quilt3 push` command and then exit | |
| If detailed_help=True, display detailed information about the `quilt3 push` command and then exit. |
| @@ -479,6 +503,11 @@ def create_parser(): | |||
| action="store_true", | |||
| help="Do not copy data. Package manifest entries will reference the data at the original location.", | |||
| ) | |||
| optional_args.add_argument( | |||
| "--detailed_help", | |||
There was a problem hiding this comment.
I think you could make requested change given #3439 is merged.
| @@ -4,3 +4,6 @@ test: | |||
|
|
|||
| install-local: | |||
| pip install -e .[tests] | |||
|
|
|||
| testdocs: | |||
| cd ../../testdocs && poetry install && poetry run pytest --codeblocks ../docs | |||
There was a problem hiding this comment.
Why not have a newline here?
| cd ../../testdocs && poetry install && poetry run pytest --codeblocks ../docs | |
| cd ../../testdocs && poetry install && poetry run pytest --codeblocks ../docs | |
Add sample code to CLI (push)