Skip to content

Commit 65f0911

Browse files
[Improvements] Improvements to command docs.
This commit improves documentation for the following list of commands. discard_all_modified, git_config, navigate_to_commit_message, navigate_to_context_commit navigate_to_commit, navigate_to_branch, navigate_to_child, navigate_to_parent, open_in_editor, push_tag, quick_open_repository, stage_all_untracked, stage_all_unmerged
1 parent 7f3d15b commit 65f0911

7 files changed

Lines changed: 54 additions & 11 deletions

File tree

sm_commands_metadata/d.json

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -96,6 +96,12 @@
9696
"added": 1104,
9797
"type": "core"
9898
},
99+
"discard_all_modified": {
100+
"command_type": "window",
101+
"doc_string": null,
102+
"added": 2061,
103+
"type": "core"
104+
},
99105
"delete_tag_on_remote": {
100106
"command_type": "window",
101107
"doc_string": null,

sm_commands_metadata/g.json

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -203,21 +203,21 @@
203203
},
204204
"git_config": {
205205
"command_type": "window",
206-
"doc_string": null,
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.",
207207
"args": [
208208
{
209209
"name": "key",
210-
"doc_string": null,
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.",
211211
"type": "string"
212212
},
213213
{
214214
"name": "value",
215-
"doc_string": null,
215+
"doc_string": "The target value.",
216216
"type": "string"
217217
},
218218
{
219219
"name": "is_default_value",
220-
"doc_string": null,
220+
"doc_string": "Whether to set this as the default checked item in the menu.",
221221
"type": "boolean"
222222
}
223223
],

sm_commands_metadata/n.json

Lines changed: 25 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -13,10 +13,16 @@
1313
},
1414
"navigate_to_commit_message": {
1515
"command_type": "window",
16-
"doc_string": null,
16+
"doc_string": "Brings the focus to the commit message dialog.",
1717
"added": 1055,
1818
"type": "core"
1919
},
20+
"navigate_to_context_commit": {
21+
"command_type": "window",
22+
"doc_string": "Navigates to the commit referenced (through it's hash) in the commit message.",
23+
"added": 2060,
24+
"type": "core"
25+
},
2026
"navigate_to_head": {
2127
"command_type": "window",
2228
"doc_string": null,
@@ -25,13 +31,27 @@
2531
},
2632
"navigate_to_commit": {
2733
"command_type": "window",
28-
"doc_string": null,
34+
"doc_string": "Navigates to the given commit.",
35+
"args": [
36+
{
37+
"name": "commit",
38+
"doc_string": "The hash of the commit you want to navigate to. Passing in a non existent commit hash will throw an error dialog.",
39+
"type": "string"
40+
}
41+
],
2942
"added": 1055,
3043
"type": "core"
3144
},
3245
"navigate_to_branch": {
3346
"command_type": "window",
34-
"doc_string": null,
47+
"doc_string": "Navigates to the given branch.",
48+
"args": [
49+
{
50+
"name": "branch",
51+
"doc_string": "The name of the branch.",
52+
"type": "string"
53+
}
54+
],
3555
"added": 1100,
3656
"type": "core"
3757
},
@@ -50,13 +70,13 @@
5070
},
5171
"navigate_to_child": {
5272
"command_type": "window",
53-
"doc_string": null,
73+
"doc_string": "Navigates to the child commit of the currently focussed commit.",
5474
"added": 1200,
5575
"type": "core"
5676
},
5777
"navigate_to_parent": {
5878
"command_type": "window",
59-
"doc_string": null,
79+
"doc_string": "Navigates to the parent commit of the currently focussed commit.",
6080
"added": 1104,
6181
"type": "core"
6282
},

sm_commands_metadata/o.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@
3333
},
3434
{
3535
"name": "default",
36-
"doc_string": null,
36+
"doc_string": "Populates the file with the contents set in this argument, if the opened file happens to be empty.",
3737
"type": "string"
3838
}
3939
],

sm_commands_metadata/p.json

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -45,6 +45,11 @@
4545
"name": "ref",
4646
"doc_string": null,
4747
"type": "string"
48+
},
49+
{
50+
"name": "remote",
51+
"doc_string": null,
52+
"type": "string"
4853
}
4954
],
5055
"added": 1055,

sm_commands_metadata/q.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
},
88
"quick_open_repository": {
99
"command_type": "window",
10-
"doc_string": null,
10+
"doc_string": "Opens the Select repository window to switch to a new repository.",
1111
"added": 1055,
1212
"type": "core"
1313
}

sm_commands_metadata/s.json

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -58,6 +58,18 @@
5858
"added": 1113,
5959
"type": "core"
6060
},
61+
"stage_all_untracked": {
62+
"command_type": "window",
63+
"doc_string": null,
64+
"added": 2061,
65+
"type": "core"
66+
},
67+
"stage_all_unmerged": {
68+
"command_type": "window",
69+
"doc_string": null,
70+
"added": 2061,
71+
"type": "core"
72+
},
6173
"search": {
6274
"command_type": "window",
6375
"doc_string": "Opens the search mode.",

0 commit comments

Comments
 (0)