Hopiu/micro
1
0
Fork 0
mirror of https://github.com/Hopiu/micro.git synced 2026-03-17 06:20:28 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Made apparent the functionality of the ftoptions plugin (#2321)

Browse source 
* 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
This commit is contained in:
Evan Shimoniak 2022-02-11 14:15:26 -08:00 committed by GitHub
parent 031d953ed5
commit 9ca89ad300
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 6 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
runtime/help/options.md
View file

@ -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`

2
runtime/help/plugins.md
View file

@ -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.