DOC: update strings for command categories #7027
Merged
Conversation
This file contains 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
I do like being happy, and I enjoy other people being happy. I also celebrate whimsy. However, this epilogue is rendered in a way that makes it seem to be a category of subcommands (confusing) and completely empty --- which is wholly depressing.
|
Code Climate has analyzed commit c5b1352 and detected 0 issues on this pull request. View more on Code Climate. |
yarikoptic
approved these changes
Sep 12, 2022
| @@ -64,7 +64,7 @@ | |||
| ]) | |||
|
|
|||
| _group_2metadata = ( | |||
| 'Commands for metadata handling', | |||
| 'Metadata', | |||
There was a problem hiding this comment.
minor but might want to avoid modifying this to avoid conflict with #7014
yarikoptic
added
the
CHANGELOG-missing
|
note: CI was red for appveyor and travis for a reason! See e.g. https://app.travis-ci.com/github/datalad/datalad/builds/255439732 . I will submit a PR to fix. |
yarikoptic
added a commit
to yarikoptic/datalad
that referenced
this pull request
Sep 15, 2022
Redness fatigue made us merge datalad#7027 without seeing that test failed. Daily tests of datalad/git-annex started to fail which let me to detect this === Do not change lines below === { "chain": [], "cmd": "sed -i -e 's,Miscellaneous commands,Miscellaneous,g' '{outputs}'", "exit": 0, "extra_inputs": [], "inputs": [], "outputs": [ "datalad/cli/tests/test_main.py" ], "pwd": "." } ^^^ Do not change lines above ^^^
|
PR released in |
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.
The new DataLad Gooey-GUI-Gew~wee uses the category strings for commands for the UI, which increases the visibility of this problem.
This PR intends to achieve the following:
I looked at
git --help, and I /really/ like the way that they organize their subcommands. However, such a change for DataLad would involve a pretty significant reorganization of the subcommand categories, which I anticipate would be controversial. I aim for this change to enter first, and if there's desire for a further refinement of organization, then that could follow.Lastly, this PR removes an epilogue from the DataLad help. Accusations of me of being a curmudgeon would not be entirely out of line --- but I do find the current rendering to be confusing. If indeed we want people to be happy, we should not confuse them in the process.
If there's strong support for the retention of the terse-and-imperative-message-of-optimism, then I can amend this PR to adjust the surrounding whitespace.
Changelog
📝 Documentation