mirror of
https://gitea.com/gitea/tea.git
synced 2026-10-26 11:01:25 +01:00
docs(help): trim examples and verbose doc comments in core commands
Signed-off-by: bircni <bircni@icloud.com>
This commit is contained in:
7 files changed
+22
-57
No files matched your search
@@ -194,10 +194,7 @@ ssh_certificate_principal, ssh_key_fingerprint.`}
|
||||
get := &cobra.Command{
|
||||
Use: "get <key>", Short: "Print the value of a setting", Args: argsExact(1), ValidArgsFunction: a.completeConfig,
|
||||
Example: `$ tea config get editor
|
||||
# Show where the value comes from
|
||||
$ tea config get default_host --show-source
|
||||
# Read an instance or account setting
|
||||
$ tea config get ssh_host --host https://gitea.com
|
||||
$ tea config get ssh_key --host https://gitea.com --user alice`,
|
||||
RunE: func(cmd *cobra.Command, args []string) error {
|
||||
snapshot, err := a.settings()
|
||||
@@ -259,11 +256,6 @@ $ tea config list --host https://gitea.com`,
|
||||
Use: "set <key> <value>", Short: "Change a setting", Args: argsExact(2), ValidArgsFunction: a.completeConfig,
|
||||
Annotations: textOutput("config set does not return a resource"),
|
||||
Example: `$ tea config set editor "code --wait"
|
||||
$ tea config set git_protocol ssh
|
||||
# Keep raw markdown and plain IDs on a terminal
|
||||
$ tea config set markdown raw
|
||||
$ tea config set hyperlinks never
|
||||
# Change an instance or account setting
|
||||
$ tea config set ssh_host git.example.com:2222 --host https://example.com
|
||||
$ tea config set ssh_key ~/.ssh/id_ed25519 --host https://example.com --user alice`,
|
||||
RunE: func(cmd *cobra.Command, args []string) error {
|
||||
|
||||
Reference in new issue
Block a user