Skip to content

Commit

Permalink
[Improvements] Improvements to command docs.
Browse files Browse the repository at this point in the history
This commit improves documentation for the following list of commands.

Sublime Merge
-------------
1. `commit`
2. `create_branch`
3. `create_tag`
4. `clean_working_dir`
5. `checkout_local_branch`
6. `delete_branch`
7. `delete_tag`
8. `discard_hunk`
9. `prompt_open_repository`
10. `rename_branch`
11. `reset`
12. `set_word_wrap`

Sublime Text
------------
None
  • Loading branch information
UltraInstinct05 committed Nov 22, 2021
1 parent e9b8648 commit 68bfc3c
Show file tree
Hide file tree
Showing 5 changed files with 73 additions and 9 deletions.
40 changes: 37 additions & 3 deletions sm_commands_metadata/c.json
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@
{
"name": "options",
"doc_string": null,
"type": "List<string>"
"type": "List[string]"
}
],
"added": 1055,
Expand Down Expand Up @@ -55,7 +55,7 @@
},
"create_branch": {
"command_type": "window",
"doc_string": "Create the given branch.",
"doc_string": "Creates the given branch.",
"args": [
{
"name": "commit",
Expand All @@ -66,6 +66,16 @@
"name": "prefix",
"doc_string": null,
"type": "string"
},
{
"name": "name",
"doc_string": "The name of the branch.",
"type": "string"
},
{
"name": "branch",
"doc_string": null,
"type": "string"
}
],
"added": 1055,
Expand All @@ -85,6 +95,16 @@
"name": "commit",
"doc_string": null,
"type": "string"
},
{
"name": "message",
"doc_string": null,
"type": "string"
},
{
"name": "name",
"doc_string": "The name of the tag.",
"type": "string"
}
],
"added": 1055,
Expand All @@ -111,7 +131,14 @@
},
"clean_working_dir": {
"command_type": "window",
"doc_string": null,
"doc_string": "Deletes all of the untracked files in the given repository.",
"args": [
{
"name": "prompt",
"doc_string": "Whether to show a confirmation dialog, asking the user to confirm the action.",
"type": "boolean"
}
],
"added": 1055,
"type": "core"
},
Expand All @@ -136,6 +163,13 @@
"checkout_local_branch": {
"command_type": "window",
"doc_string": null,
"args": [
{
"name": "remote_branch",
"doc_string": null,
"type": "string"
}
],
"added": 2042,
"type": "core"
},
Expand Down
18 changes: 15 additions & 3 deletions sm_commands_metadata/d.json
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
"args": [
{
"name": "prompt",
"doc_string": null,
"doc_string": "Whether to show a confirmation dialog, asking the user to confirm the action.",
"type": "boolean"
},
{
Expand Down Expand Up @@ -52,8 +52,13 @@
"args": [
{
"name": "prompt",
"doc_string": null,
"doc_string": "Whether to show a confirmation dialog, asking the user to confirm the action.",
"type": "boolean"
},
{
"name": "ref",
"doc_string": null,
"type": "string"
}
],
"added": 1055,
Expand Down Expand Up @@ -119,7 +124,14 @@
},
"discard_hunk": {
"command_type": "window",
"doc_string": null,
"doc_string": "Discards the changes present in the given hunk.",
"args": [
{
"name": "prompt",
"doc_string": "Whether to show a confirmation dialog, asking the user to confirm the action.",
"type": "boolean"
}
],
"added": 1055,
"type": "core"
}
Expand Down
2 changes: 1 addition & 1 deletion sm_commands_metadata/p.json
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
},
"prompt_open_repository": {
"command_type": "window",
"doc_string": null,
"doc_string": "Opens the default OS dialog to select a git repository. The repository is opened in a seperate tab.",
"added": 1055,
"type": "core"
},
Expand Down
9 changes: 7 additions & 2 deletions sm_commands_metadata/r.json
Original file line number Diff line number Diff line change
Expand Up @@ -19,12 +19,17 @@
},
"rename_branch": {
"command_type": "window",
"doc_string": null,
"doc_string": "Renames the given branch.",
"args": [
{
"name": "branch",
"doc_string": null,
"type": "string"
},
{
"name": "new_name",
"doc_string": "The new name for the branch.",
"type": "string"
}
],
"added": 1055,
Expand Down Expand Up @@ -66,7 +71,7 @@
},
{
"name": "mode",
"doc_string": "Valid values are 'soft', 'Hard', 'mixed'",
"doc_string": "Valid values are 'soft', 'hard' and 'mixed'.",
"type": "string"
}
],
Expand Down
13 changes: 13 additions & 0 deletions sm_commands_metadata/s.json
Original file line number Diff line number Diff line change
Expand Up @@ -190,5 +190,18 @@
"doc_string": "Saves the edited commit message while the commit message is in an edit mode.",
"added": 1055,
"type": "core"
},
"set_word_wrap": {
"command_type": "window",
"doc_string": "Sets the word wrap for the diff hunks.",
"args": [
{
"name": "word_wrap",
"doc_string": "The mode for the word wrap. Valid values are 'true', 'false' & 'auto'. 'true' enables the wordwrap & 'false' disables the word wrap.",
"type": "string | boolean"
}
],
"added": 1088,
"type": "core"
}
}

0 comments on commit 68bfc3c

Please sign in to comment.