Add documentation

* `replace`
* `switch_case`
* `switch_to_uppercase`
* `switch_to_lowercase`
pull/997/head
Omnikar 3 years ago
parent 3dcd18d621
commit aee10cf741
No known key found for this signature in database
GPG Key ID: 7DE6694CDA7885ED

@ -0,0 +1,21 @@
`replace`
Waits for another keypress, then replaces all
selected characters with the pressed key.
--- Examples ---
'a' is replaced with 'e'.
┌──────────────────────────┐ e ┌──────────────────────────┐
│ Do this, th[a]n do that. │ --> │ Do this, th[e]n do that. │
└──────────────────────────┘ └──────────────────────────┘
All instances of ',' are replaced with '.'.
┌──────────────────────────────┐ . ┌──────────────────────────────┐
│ This sentence continues(,,,] │ --> │ This sentence continues(...] │
└──────────────────────────────┘ └──────────────────────────────┘
All instances of 'a' are replaced with 'e'.
┌──────────────────────────────────┐ e ┌──────────────────────────────────┐
│ 1, th[a]n 2, th[a]n 3, th[a]n 4. │ --> │ 1, th[e]n 2, th[e]n 3, th[e]n 4. │
└──────────────────────────────────┘ └──────────────────────────────────┘

@ -0,0 +1,13 @@
`switch_case`
Toggles the case of all selected letters.
--- Examples ---
┌───────────────────────┐ ┌───────────────────────┐
│ [t]his is a sentence. │ --> │ [T]his is a sentence. │
└───────────────────────┘ └───────────────────────┘
┌───────────────────────┐ ┌───────────────────────┐
│ (tHIS] is a sentence. │ --> │ (This] is a sentence. │
└───────────────────────┘ └───────────────────────┘

@ -0,0 +1,9 @@
`switch_to_lowercase`
Changes all selected letters to lowercase.
--- Examples ---
┌──────────────────────────────────┐ ┌──────────────────────────────────┐
│ This (wOrD] should be lowercase. │ --> │ This (word] should be lowercase. │
└──────────────────────────────────┘ └──────────────────────────────────┘

@ -0,0 +1,9 @@
`switch_to_uppercase`
Changes all selected letters to uppercase.
--- Examples ---
┌──────────────────────────────────┐ ┌──────────────────────────────────┐
│ This (wOrD] should be uppercase. │ --> │ This (WORD] should be uppercase. │
└──────────────────────────────────┘ └──────────────────────────────────┘
Loading…
Cancel
Save