Clarify error message re unspecified gitlab project#5907
Merged
mih merged 1 commit intodatalad:maintfrom Aug 17, 2021
Merged
Conversation
Issue
```
% datalad create-sibling-gitlab --site gitlab.com
create_sibling_gitlab(error): . (dataset) [No project path specified, and no configuration to derive one]
% datalad create-sibling-gitlab -h
Usage: datalad create-sibling-gitlab [-h] [--site SITENAME] [--project NAME/LOCATION]
[--layout {hierarchy|collection|flat}] [--dataset DATASET] [-r] [-R LEVELS]
[-s NAME] [--existing {skip|error|reconfigure}] [--access {http|ssh|ssh+http}]
[--publish-depends SIBLINGNAME] [--description DESCRIPTION] [--dryrun]
[PATH ...]
```
The error message is hinting at a missing PATH, but --project is
required instead.
This change standardizes on using the terms from the existing metavar
spec, in the docs and the error message to reduce the confusion:
```
create_sibling_gitlab(error): . (dataset) [No project name/location specified, and no configuration to derive one]
```
Fixes datalad#5764
Codecov Report
@@ Coverage Diff @@
## maint #5907 +/- ##
===========================================
- Coverage 90.32% 29.54% -60.78%
===========================================
Files 300 297 -3
Lines 42396 42360 -36
===========================================
- Hits 38294 12517 -25777
- Misses 4102 29843 +25741
Continue to review full report at Codecov.
|
Member
Author
|
OK, I complained about the message, I think it is better now. Will merge now-ish. |
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
1 participant
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.
Issue
The error message is hinting at a missing PATH, but --project is
required instead.
This change standardizes on using the terms from the existing metavar
spec, in the docs and the error message to reduce the confusion:
Fixes #5764