Improve CLI code and descriptions #28482
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
Contributor
wxiaoguang
commented
Dec 15, 2023
•
wxiaoguang
commented
- Close cli.HelpFlag = nil can be used now when update urfave/cli to v2.26.0 #28444
- Actually, it doesn't need to use that trick because it looks like it is not necessary, no user really needs it
- Remove the hidden (legacy) "doctor" subcommand and update documents
- Fix "actions" usage
GiteaBot
added
the
lgtm/need 2
pull-request-size
bot
added
the
size/M
github-actions
bot
added
modifies/cli
wxiaoguang
force-pushed
the
fix-cli
branch
2 times, most recently
from
d2f6ec4 to
501ef4e
Compare
delvh
approved these changes
Dec 15, 2023
cmd/main.go
Outdated
| app.Usage = "A painless self-hosted Git service" | ||
| app.Description = `By default, Gitea will start serving using the web-server with no argument, which can alternatively be run by running the subcommand "web".` | ||
| app.Description = `Gitea program contains "web" and other subcommands. If no subcommand is given, it starts the web server by default. Use "web" subcommand for more web server arguments, user other subcommands for other features.` |
There was a problem hiding this comment.
Suggested change
| app.Description = `Gitea program contains "web" and other subcommands. If no subcommand is given, it starts the web server by default. Use "web" subcommand for more web server arguments, user other subcommands for other features.` | |
| app.Description = `The gitea binary contains multiple subcommands, among them "web" . If no subcommand is given, the web server is started. Use the "web" subcommand to configure how the web server is started, or another subcommand for other purposes.` |
There was a problem hiding this comment.
I am not a fan of using "the" everywhere.
See the screenshot and old sentences, we never say "the Gitea web server", "Dump the Gitea files", "output the CLI document".
When to Use 'A,' 'An,' or 'The'
There was a problem hiding this comment.
The reason that I think we should put "web" subcommand before others: it is the default one and is the only one most users really need.
I am not a native English speaks but among them "web" reads strange to me.
GiteaBot
added
lgtm/need 1
silverwind
reviewed
Dec 15, 2023
lunny
approved these changes
Dec 15, 2023
GiteaBot
added
lgtm/done
lunny
added
the
reviewed/wait-merge
GiteaBot
removed
the
reviewed/wait-merge
zjjhot
added a commit
to zjjhot/gitea
that referenced
this pull request
Dec 16, 2023
* upstream/main: Update docs for DISABLE_QUERY_AUTH_TOKEN (go-gitea#28485) Improve CLI code and descriptions (go-gitea#28482) Remove unnecessary forgot password link in delete user section (go-gitea#28355)
fuxiaohei
pushed a commit
to fuxiaohei/gitea
that referenced
this pull request
Jan 17, 2024
* Close go-gitea#28444 * Actually, it doesn't need to use that trick because it looks like it is not necessary, no user really needs it * Remove the hidden (legacy) "doctor" subcommand and update documents * Fix "actions" usage 
silverwind
pushed a commit
to silverwind/gitea
that referenced
this pull request
Feb 20, 2024
* Close go-gitea#28444 * Actually, it doesn't need to use that trick because it looks like it is not necessary, no user really needs it * Remove the hidden (legacy) "doctor" subcommand and update documents * Fix "actions" usage 
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.