From 9ca89ad300225bdf899786ac45fb5905be50e8ca Mon Sep 17 00:00:00 2001 From: Evan Shimoniak Date: Fri, 11 Feb 2022 14:15:26 -0800 Subject: [PATCH] Made apparent the functionality of the ftoptions plugin (#2321) * Clarified meaning of indentchar setting The description "sets the indentation character" combined with the default value of a space led me to believe that this was a way to set a preference for tabs/spaces and choose a number of spaces per indentation all at once. I've updated the description to try to make its true function clearer. * Added note on rmtrailingws This behavior was unexpected for me, so it's probably good to let other users know which option has precedence. * Added details to help command Initially I kept trying to use `help ` rather than `help commands` * Added warning about ftoptions and tabstospaces The current description for ftoptions states that it "alters some default options depending on the filetype", which hints at this behavior, but does not explicitly state it. * Clarified specific functionality of ftoptions --- runtime/help/options.md | 6 +++++- runtime/help/plugins.md | 2 +- 2 files changed, 6 insertions(+), 2 deletions(-) diff --git a/runtime/help/options.md b/runtime/help/options.md index 6b872398..0c6019ec 100644 --- a/runtime/help/options.md +++ b/runtime/help/options.md @@ -369,7 +369,11 @@ Here are the available options: default value: `4` -* `tabstospaces`: use spaces instead of tabs. +* `tabstospaces`: use spaces instead of tabs. Note: This option will be + overridden by [the `ftoptions` plugin](https://github.com/zyedidia/micro/blob/master/runtime/plugins/ftoptions/ftoptions.lua) + for certain filetypes. To disable this behavior, add `"ftoptions": false` to + your config. See [issue #2213](https://github.com/zyedidia/micro/issues/2213) + for more details. default value: `false` diff --git a/runtime/help/plugins.md b/runtime/help/plugins.md index d959488c..c2e202ac 100644 --- a/runtime/help/plugins.md +++ b/runtime/help/plugins.md @@ -401,7 +401,7 @@ There are 6 default plugins that come pre-installed with micro. These are * `autoclose`: automatically closes brackets, quotes, etc... * `comment`: provides automatic commenting for a number of languages -* `ftoptions`: alters some default options depending on the filetype +* `ftoptions`: alters some default options (notably indentation) depending on the filetype * `linter`: provides extensible linting for many languages * `literate`: provides advanced syntax highlighting for the Literate programming tool. -- 2.44.0