From c5437ca6620132d4fd3029e10711f2613e7f6361 Mon Sep 17 00:00:00 2001 From: Steven Guh Date: Mon, 15 Feb 2021 15:11:02 -0800 Subject: [PATCH 1/3] Document issue where `,` can't find previous match --- docs/major-mode.md | 9 +++++++-- docs/troubleshooting.md | 21 +++++++++++++++++++++ 2 files changed, 28 insertions(+), 2 deletions(-) diff --git a/docs/major-mode.md b/docs/major-mode.md index 56a5372..afc3c7f 100644 --- a/docs/major-mode.md +++ b/docs/major-mode.md @@ -6,10 +6,15 @@ title: Major Mode Major mode offers dynamic menu and functions based on the active buffer. You can access key bindings specific to the current major mode by pressing ` m` or `,` if you want to save one keystroke. -:::note +:::tip If `,` isn't bound, you might need to update your settings. You can add the necessary keybindings to your `settings.json` by pressing `Ctrl+Shift+p` and running the command "VSpaceCode: Configure Default Settings". -More information can be found in the [Installation](./) instructions. +More information can be found in the [Installation](./) for instructions. +::: + +:::note +The default configuration uses `,` as the shortcut to major mode, that will override the find previous match after a `f{character}`. +You can following the instruction in [Troubleshooting](./troubleshooting) to remove or modify the shortcut. ::: For example, you can press ` m x b` to make the text bold in a markdown buffer. diff --git a/docs/troubleshooting.md b/docs/troubleshooting.md index 79eb08f..5d13536 100644 --- a/docs/troubleshooting.md +++ b/docs/troubleshooting.md @@ -25,6 +25,27 @@ If you don't use this feature, disabling it should fix this issue. Otherwise, ad ], ``` +## `,` cannot find previous match + +When the key `,` cannot get back to the previous match after a find `f{character}` with Vim. +This is because the default VSpaceCode configuration overrides `,` as a shortcut for the major mode. +You can remove follow settings in your `settings.json` to remove this shortcut. + +```json +{ + "before": [","], + "commands": [ + "vspacecode.space", + { + "command": "whichkey.triggerKey", + "args": "m" + } + ], +} +``` + +You can also change the shortcut key by changing `","` in `"before"` to other keys. + ## Unresponsive menu activation If you press `` on a buffer and the which-key menu doesn't appear immediately, you might have one of the following problems. From feae50bca08aa0077834842fde8d6af958e86b1d Mon Sep 17 00:00:00 2001 From: Steven Guh Date: Sun, 21 Feb 2021 19:15:42 -0800 Subject: [PATCH 2/3] Apply suggestions from code review Co-authored-by: Marco Ieni <11428655+MarcoIeni@users.noreply.github.com> --- docs/major-mode.md | 4 ++-- docs/troubleshooting.md | 9 +++++---- 2 files changed, 7 insertions(+), 6 deletions(-) diff --git a/docs/major-mode.md b/docs/major-mode.md index afc3c7f..839949c 100644 --- a/docs/major-mode.md +++ b/docs/major-mode.md @@ -13,8 +13,8 @@ More information can be found in the [Installation](./) for instructions. ::: :::note -The default configuration uses `,` as the shortcut to major mode, that will override the find previous match after a `f{character}`. -You can following the instruction in [Troubleshooting](./troubleshooting) to remove or modify the shortcut. +The default configuration uses `,` as the shortcut to major mode, that will override the vim "find previous match" after a `f{character}`. +You can follow the instructions in [Troubleshooting](./troubleshooting#-cannot-find-previous-match) to remove or modify this shortcut. ::: For example, you can press ` m x b` to make the text bold in a markdown buffer. diff --git a/docs/troubleshooting.md b/docs/troubleshooting.md index 5d13536..f1e3138 100644 --- a/docs/troubleshooting.md +++ b/docs/troubleshooting.md @@ -27,9 +27,10 @@ If you don't use this feature, disabling it should fix this issue. Otherwise, ad ## `,` cannot find previous match -When the key `,` cannot get back to the previous match after a find `f{character}` with Vim. -This is because the default VSpaceCode configuration overrides `,` as a shortcut for the major mode. -You can remove follow settings in your `settings.json` to remove this shortcut. +The default VSpaceCode configuration overrides `,` as a shortcut for the [major mode](./major-mode.md), +therefore the key `,` cannot get back to the previous match after a find `f{character}` with Vim. + +In order to remove this major mode shortcut, remove the following section from your `settings.json`: ```json { @@ -44,7 +45,7 @@ You can remove follow settings in your `settings.json` to remove this shortcut. } ``` -You can also change the shortcut key by changing `","` in `"before"` to other keys. +Alternatively, you can change the shortcut key by changing `","` in `"before"` to other keys. ## Unresponsive menu activation From 3d4c862ab15d5131c6e437654e6676a2732cf4f0 Mon Sep 17 00:00:00 2001 From: Steven Guh Date: Sun, 21 Feb 2021 19:17:40 -0800 Subject: [PATCH 3/3] punctuation --- docs/troubleshooting.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/troubleshooting.md b/docs/troubleshooting.md index f1e3138..42c18ed 100644 --- a/docs/troubleshooting.md +++ b/docs/troubleshooting.md @@ -27,8 +27,8 @@ If you don't use this feature, disabling it should fix this issue. Otherwise, ad ## `,` cannot find previous match -The default VSpaceCode configuration overrides `,` as a shortcut for the [major mode](./major-mode.md), -therefore the key `,` cannot get back to the previous match after a find `f{character}` with Vim. +The default VSpaceCode configuration overrides `,` as a shortcut for the [major mode](./major-mode.md); +therefore, the key `,` cannot get back to the previous match after a find `f{character}` with Vim. In order to remove this major mode shortcut, remove the following section from your `settings.json`: