diff --git a/docs/configuration.rst b/docs/configuration.rst index 18258d03..2b27e93b 100644 --- a/docs/configuration.rst +++ b/docs/configuration.rst @@ -190,8 +190,8 @@ or ignore paths only for specific rules: Note that this ``.gitignore``-style path pattern allows complex path exclusion/inclusion, see the `pathspec README file -`_ for more details. -Here is a more complex example: +`_ for more details. Here is a more complex +example: .. code-block:: yaml diff --git a/docs/index.rst b/docs/index.rst index 958c9512..5456d6a6 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -11,7 +11,7 @@ Screenshot .. note:: - The default output format is inspired by `eslint `_, a + The default output format is inspired by `eslint `_, a great linting tool for Javascript. Table of contents diff --git a/docs/quickstart.rst b/docs/quickstart.rst index 9cf5f171..1502084c 100644 --- a/docs/quickstart.rst +++ b/docs/quickstart.rst @@ -4,7 +4,7 @@ Quickstart Installing yamllint ------------------- -On Fedora / CentOS (note: `EPEL `_ is +On Fedora / CentOS (note: `EPEL `_ is required on CentOS): .. code:: bash diff --git a/docs/text_editors.rst b/docs/text_editors.rst index b3058d83..12387e65 100644 --- a/docs/text_editors.rst +++ b/docs/text_editors.rst @@ -13,7 +13,7 @@ Assuming that the `ALE `_ plugin is installed, yamllint is supported by default. It is automatically enabled when editing YAML files. -If you instead use the `syntastic `_ +If you instead use the `syntastic `_ plugin, add this to your ``.vimrc``: :: @@ -23,7 +23,7 @@ plugin, add this to your ``.vimrc``: Neovim ------ -Assuming that the `neomake `_ plugin is +Assuming that the `neomake `_ plugin is installed, yamllint is supported by default. It is automatically enabled when editing YAML files. diff --git a/yamllint/rules/new_line_at_end_of_file.py b/yamllint/rules/new_line_at_end_of_file.py index 9a334c85..302cfe6a 100644 --- a/yamllint/rules/new_line_at_end_of_file.py +++ b/yamllint/rules/new_line_at_end_of_file.py @@ -17,7 +17,7 @@ Use this rule to require a new line character (``\\n``) at the end of files. The POSIX standard `requires the last line to end with a new line character -`_. +`_. All UNIX tools expect a new line at the end of files. Most text editors use this convention too. """