Skip to content

Commit f82c93e

Browse files
[Improvements] Improvements to command docs.
This commit improves documentation for the following list of commands. git_config, show_command_palette
1 parent 65f0911 commit f82c93e

2 files changed

Lines changed: 10 additions & 5 deletions

File tree

sm_commands_metadata/g.json

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -203,22 +203,27 @@
203203
},
204204
"git_config": {
205205
"command_type": "window",
206-
"doc_string": "Sets the given key value pair in your git config. Shows a dialog box asking whether the key value pair must be set for the global git config or only for the current repository.",
206+
"doc_string": "Sets the given key value pair in your git config.",
207207
"args": [
208208
{
209209
"name": "key",
210-
"doc_string": "The target key. Refer to the official git docs https://git-scm.com/docs/git-config for more information on key value pairs.",
210+
"doc_string": "The target key. Refer to the official git docs https://git-scm.com/docs/git-config for more information on available key value pairs.",
211211
"type": "string"
212212
},
213213
{
214214
"name": "value",
215-
"doc_string": "The target value.",
215+
"doc_string": "The target value to be set for the given key.",
216216
"type": "string"
217217
},
218218
{
219219
"name": "is_default_value",
220220
"doc_string": "Whether to set this as the default checked item in the menu.",
221221
"type": "boolean"
222+
},
223+
{
224+
"name": "is_global",
225+
"doc_string": "Whether to set this key value pair for the global git config or the local one. If the argument is not provided, then a dialog is shown asking the user to pick.",
226+
"type": "boolean"
222227
}
223228
],
224229
"added": 1070,

sm_commands_metadata/s.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@
1515
},
1616
{
1717
"name": "description",
18-
"doc_string": "The arguments to be passed to the command.",
18+
"doc_string": "The description for the command shown as an InputHandler label.",
1919
"type": "string"
2020
}
2121
],
@@ -60,7 +60,7 @@
6060
},
6161
"stage_all_untracked": {
6262
"command_type": "window",
63-
"doc_string": null,
63+
"doc_string": "Stages all untracked files in the given repository.",
6464
"added": 2061,
6565
"type": "core"
6666
},

0 commit comments

Comments
 (0)