Clarified some documentation (#2259)

* 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`
This commit is contained in:
Evan Shimoniak
2021-11-02 13:26:14 -07:00
committed by GitHub
parent 7df91eb038
commit 58e3cc1be0
2 changed files with 10 additions and 3 deletions

View File

@@ -22,7 +22,9 @@ quotes here but these are not necessary when entering the command in micro.
`key` that already exist.
* `help 'topic'?`: opens the corresponding help topic. If no topic is provided
opens the default help screen.
opens the default help screen. Help topics are stored as `.md` files in the
`runtime/help` directory of the source tree, which is embedded in the final
binary.
* `save 'filename'?`: saves the current buffer. If the file is provided it
will 'save as' the filename.

View File

@@ -176,7 +176,12 @@ Here are the available options:
default value: `true`
* `indentchar`: sets the indentation character.
* `indentchar`: sets the indentation character. This will not be inserted into
files; it is only a visual indicator that whitespace is present. If set to a
printing character, it functions as a subset of the "show invisibles"
setting available in many other text editors. The color of this character is
determined by the `indent-char` field in the current theme rather than the
default text color.
default value: ` ` (space)
@@ -262,7 +267,7 @@ Here are the available options:
default value: `false`
* `rmtrailingws`: micro will automatically trim trailing whitespaces at ends of
lines.
lines. Note: This setting overrides `keepautoindent`
default value: `false`