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 <command-name>` 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

diff --git a/runtime/help/options.md b/runtime/help/options.md
index 6b872398a0b2bb3e9f9f826408b73deb3d2baf02..0c6019ec2c0fc5d9ed190da220b991e521ff659c 100644 (file)
--- 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 d959488ca5aa2cb4f1112674b48837dd3fd4a340..c2e202ac84394c368a2f98cae2d8616e49a86d9b 100644 (file)
--- 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.