Update settings documentation

gediminasz · Oct 3, 2023 · 874b110 · 874b110
1 parent 54460cf
commit 874b110
Show file tree

Hide file tree

Showing 3 changed files with 12 additions and 10 deletions.
diff --git a/NOTES.md b/NOTES.md
@@ -19,6 +19,8 @@
     * A pre-release version may look something like this: `2023.9.0-beta`.
 1. Ensure `CHANGELOG.md` is up to date.
     * Change the "Unreleased" heading to the version you are about to release.
+1. Ensure `README.md` is up to date.
+    * Use `make docs` to generate the Settings section.
 1. Commit changes.
 1. `make publish`
 1. Create a release together with a new tag in GitHub.
diff --git a/README.md b/README.md
@@ -36,29 +36,29 @@ Document selector object used when registering symbol providers, read more at ht
 
 ### `ctags-companion.readtagsGoToDefinitionCommand`
 
-Default: `"readtags --extension-fields --line-number"`
+Default: `"readtags -en"`
 
-When `readtags` is enabled, this command is used for the "go to definition" feature (i.e. F12 or Ctrl+click).
+The command used for the "go to definition" feature (i.e. F12 or Ctrl+click).
 
 ```json
-"ctags-companion.readtagsGoToDefinitionCommand": "readtags --extension-fields --line-number"
+"ctags-companion.readtagsGoToDefinitionCommand": "readtags -en"
 ```
 
 ### `ctags-companion.readtagsGoToSymbolInWorkspaceCommand`
 
-Default: `"readtags --extension-fields --line-number --prefix-match --icase-match"`
+Default: `"readtags -enpi"`
 
-When `readtags` is enabled, this command is used for the "go to symbol in workspace" feature (i.e. Ctrl+T).
+The command used for the "go to symbol in workspace" feature (i.e. Ctrl+T).
 
 ```json
-"ctags-companion.readtagsGoToSymbolInWorkspaceCommand": "readtags --extension-fields --line-number --prefix-match --icase-match"
+"ctags-companion.readtagsGoToSymbolInWorkspaceCommand": "readtags -enpi"
 ```
 
 ### `ctags-companion.ctagsGoToSymbolInEditorCommand`
 
 Default: `"ctags --fields=+nKz -f -"`
 
-When `readtags` is enabled, this command is used for the outline and the "go to symbol in editor" feature (i.e. Ctrl+Shift+O).
+The command used for the outline and the "go to symbol in editor" feature (i.e. Ctrl+Shift+O).
 
 ```json
 "ctags-companion.ctagsGoToSymbolInEditorCommand": "ctags --fields=+nKz -f -"

diff --git a/package.json b/package.json
@@ -39,19 +39,19 @@
                 "ctags-companion.readtagsGoToDefinitionCommand": {
                     "type": "string",
                     "default": "readtags -en",
-                    "description": "When `readtags` is enabled, this command is used for the \"go to definition\" feature (i.e. F12 or Ctrl+click).",
+                    "description": "The command used for the \"go to definition\" feature (i.e. F12 or Ctrl+click).",
                     "scope": "resource"
                 },
                 "ctags-companion.readtagsGoToSymbolInWorkspaceCommand": {
                     "type": "string",
                     "default": "readtags -enpi",
-                    "description": "When `readtags` is enabled, this command is used for the \"go to symbol in workspace\" feature (i.e. Ctrl+T).",
+                    "description": "The command used for the \"go to symbol in workspace\" feature (i.e. Ctrl+T).",
                     "scope": "resource"
                 },
                 "ctags-companion.ctagsGoToSymbolInEditorCommand": {
                     "type": "string",
                     "default": "ctags --fields=+nKz -f -",
-                    "description": "When `readtags` is enabled, this command is used for the outline and the \"go to symbol in editor\" feature (i.e. Ctrl+Shift+O).",
+                    "description": "The command used for the outline and the \"go to symbol in editor\" feature (i.e. Ctrl+Shift+O).",
                     "scope": "resource"
                 }
             }