Skip to content

Commit ed922fb

Browse files
[Chore] Document the newly added setting copy_command_signature_modifier_key.
This commit adds relevant documentation about `copy_command_signature_modifier_key` to the README.
1 parent b069b03 commit ed922fb

1 file changed

Lines changed: 10 additions & 2 deletions

File tree

README.md

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -79,9 +79,17 @@ Examples:
7979

8080
The default value for this setting is `["text", "window", "application", "find"]`.
8181

82+
##### `copy_command_signature_modifier_key` (`str`)
83+
84+
This setting allows a user to configure the modifier key that is used to copy the command signature to clipboard, when the said modifier key is held while selecting a command.
85+
86+
For a list of valid modifier key values, see https://www.sublimetext.com/docs/api_reference.html#type-event_dict
87+
88+
The default value for this setting is `"ctrl"`.
89+
8290
### Key bindings.
8391

84-
This package just ships with one key binding to make it easier to open the core commands documentation panel. The key binding is <kbd>ctrl + shift + c, ctrl + shift + d</kbd>
92+
This package just ships with one key binding to make it easier to open the core commands documentation panel (If it exists). The key binding for that is <kbd>ctrl + shift + c, ctrl + shift + d</kbd>
8593

8694
### Discussions
8795

@@ -91,7 +99,7 @@ Since plugin based commands are specific to plugin/package, it's best to ask the
9199

92100
### Issues & feature requests
93101

94-
Please use the issues and feature requests template whenever filling an issue/feature request so as to stay as organised as possible.
102+
Please use the issues and feature requests template, whenever filing an issue/feature request, so as to stay as organised as possible.
95103

96104
## Contributing
97105

0 commit comments

Comments
 (0)