Skip to content

Commit 7a304f3

Browse files
UltraInstinct05UltraInstinct05
committed
[Improvements] Improvements to command docs.
This commit improves documentation for the following list of commands. select_lines, set_build_system, set_file_type, set_line_ending, show_overlay, show_panel, single_selection, slurp_find_string, slurp_replace_string, switch_file
1 parent a35f67a commit 7a304f3

1 file changed

Lines changed: 25 additions & 25 deletions

File tree

‎st_commands_metadata/s.json‎

Lines changed: 25 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -89,11 +89,11 @@
8989
},
9090
"select_lines": {
9191
"command_type": "text",
92-
"doc_string": "Select the current or next line, if the full current line is selected.",
92+
"doc_string": "Adds a new selection (cursor) to the line above or below.",
9393
"args": [
9494
{
9595
"name": "forward",
96-
"doc_string": null,
96+
"doc_string": "Whether to add the new selection (cursor) below the line.",
9797
"type": "boolean"
9898
}
9999
],
@@ -105,7 +105,7 @@
105105
"args": [
106106
{
107107
"name": "file",
108-
"doc_string": "Accepts a 'Packages/' relative path to a sublime build file to set as the current build system. An empty string will set it to the Automatic option as seen in 'Tools -> Build System'.",
108+
"doc_string": "Accepts a 'Packages/' relative path to a sublime build file to set as the current build system. An empty string will set it to the 'Automatic' option as seen in 'Tools -> Build System'.",
109109
"type": "string"
110110
}
111111
],
@@ -135,19 +135,19 @@
135135
},
136136
"set_file_type": {
137137
"command_type": "text",
138-
"doc_string": "Set the syntax for the view.",
138+
"doc_string": "Sets the syntax for the active view.",
139139
"args": [
140140
{
141141
"name": "syntax",
142-
"doc_string": "The syntax to be set for the view. Can either be a package relative path like 'Packages/Foo/Bar.sublime-syntax' or 'scope:' prefixed syntax names.",
142+
"doc_string": "The syntax to be set for the active view. Can either be a package relative path like 'Packages/Foo/Bar.sublime-syntax' or 'scope:' prefixed syntax name.",
143143
"type": "string"
144144
}
145145
],
146146
"type": "core"
147147
},
148148
"set_line_ending": {
149149
"command_type": "text",
150-
"doc_string": "Set the line endings for the files.",
150+
"doc_string": "Sets the line endings for the files.",
151151
"args": [
152152
{
153153
"name": "type",
@@ -191,7 +191,7 @@
191191
},
192192
"show_overlay": {
193193
"command_type": "window",
194-
"doc_string": "Show the overlay from the argument.",
194+
"doc_string": "Shows the overlay from the argument.",
195195
"args": [
196196
{
197197
"name": "overlay",
@@ -210,7 +210,7 @@
210210
},
211211
{
212212
"name": "command",
213-
"doc_string": "The name of the command. Only makes sense when 'name' is set to 'command_palette'",
213+
"doc_string": "The name of the command. Only makes sense when 'overlay' is set to 'command_palette'",
214214
"type": "string"
215215
},
216216
{
@@ -242,57 +242,57 @@
242242
},
243243
{
244244
"name": "regex",
245-
"doc_string": "Whether to activate the Regular Expression option.",
245+
"doc_string": "Whether to activate the 'Regular Expression' option.",
246246
"type": "boolean"
247247
},
248248
{
249249
"name": "case_sensitive",
250-
"doc_string": "Whether to activate the Case sensitive option.",
250+
"doc_string": "Whether to activate the 'Case sensitive' option.",
251251
"type": "boolean"
252252
},
253253
{
254254
"name": "whole_word",
255-
"doc_string": "Whether to activate the Whole word option.",
255+
"doc_string": "Whether to activate the 'Whole word' option.",
256256
"type": "boolean"
257257
},
258258
{
259259
"name": "wrap",
260-
"doc_string": "Whether to activate the Wrap option.",
260+
"doc_string": "Whether to activate the 'Wrap' option.",
261261
"type": "boolean"
262262
},
263263
{
264264
"name": "in_selection",
265-
"doc_string": "Whether to activate the In selection option.",
265+
"doc_string": "Whether to activate the 'In selection' option.",
266266
"type": "boolean"
267267
},
268268
{
269269
"name": "highlight",
270-
"doc_string": "Whether to activate the Highlight matches option.",
270+
"doc_string": "Whether to activate the 'Highlight matches' option.",
271271
"type": "boolean"
272272
},
273273
{
274274
"name": "preserve_case",
275-
"doc_string": "Whether to activate the Preserve Case option.",
275+
"doc_string": "Whether to activate the 'Preserve Case' option.",
276276
"type": "boolean"
277277
},
278278
{
279279
"name": "show_context",
280-
"doc_string": "Whether to activate the Show Context option.",
280+
"doc_string": "Whether to activate the 'Show Context' option.",
281281
"type": "boolean"
282282
},
283283
{
284284
"name": "use_buffer",
285-
"doc_string": "Whether to activate the Use Buffer option.",
285+
"doc_string": "Whether to activate the 'Use Buffer' option.",
286286
"type": "boolean"
287287
},
288288
{
289289
"name": "use_gitignore",
290-
"doc_string": "Whether to activate the Use gitignore option.",
290+
"doc_string": "Whether to activate the 'Use gitignore' option.",
291291
"type": "boolean"
292292
},
293293
{
294294
"name": "where",
295-
"doc_string": "The text to be put in the 'Where' field of Find in Files panel. Only makes sense when the 'panel' equals 'find_in_files'.",
295+
"doc_string": "The text to be put in the 'Where' field of 'Find in Files' panel. Only makes sense when the 'panel' equals 'find_in_files'.",
296296
"type": "string"
297297
}
298298
],
@@ -306,17 +306,17 @@
306306
},
307307
"single_selection": {
308308
"command_type": "text",
309-
"doc_string": "Switch to only the first selection.",
309+
"doc_string": "Switches to the first selection.",
310310
"type": "core"
311311
},
312312
"slurp_find_string": {
313313
"command_type": "window",
314-
"doc_string": "Use the current selection as the find string.",
314+
"doc_string": "Uses the current selection as the find string.",
315315
"type": "core"
316316
},
317317
"slurp_replace_string": {
318318
"command_type": "window",
319-
"doc_string": "Use the current selection as the replacement string.",
319+
"doc_string": "Uses the current selection as the replacement string.",
320320
"type": "core"
321321
},
322322
"soft_redo": {
@@ -504,16 +504,16 @@
504504
},
505505
"switch_file": {
506506
"command_type": "window",
507-
"doc_string": "",
507+
"doc_string": "Switches between files having the same name and the specified extensions, additionally opening the file if it's not already open.",
508508
"args": [
509509
{
510510
"name": "extensions",
511-
"doc_string": null,
511+
"doc_string": "The list of allowed extensions.",
512512
"type": "List[string]"
513513
},
514514
{
515515
"name": "side_by_side",
516-
"doc_string": null,
516+
"doc_string": "Whether to add the file to the group's multiselected sheets while switching.",
517517
"type": "boolean"
518518
}
519519
],

0 commit comments

Comments
 (0)