branch: elpa/flycheck
commit fbbf5c2fab4ff5a3023a08ce379171a637ad8f68
Author: Bozhidar Batsov <[email protected]>
Commit: Bozhidar Batsov <[email protected]>
Fix documentation typos, grammar, and markup issues
Fix ~50 issues across 20 documentation files: typos (e.g. "sementics",
"Vailed", "changelo"), grammar errors (e.g. "a error", "comply to",
"how extend"), wrong words (e.g. "MacOS" → "macOS", "major nodes" →
"major modes"), markup problems (stray colon, mismatched quotes,
duplicate link target), stale references to removed ERT test
infrastructure, and non-breaking space characters.
---
doc/community/extensions.rst | 6 +++---
doc/community/get-help.rst | 2 +-
doc/community/people.rst | 4 ++--
doc/conf.py | 6 +++---
doc/contributor/contributing.rst | 24 ++++++------------------
doc/contributor/maintaining.rst | 14 +++++++-------
doc/contributor/style-guide.rst | 9 ++++-----
doc/developer/developing.rst | 8 ++++----
doc/glossary.rst | 8 ++++----
doc/index.rst | 10 +++++-----
doc/languages.rst | 9 ++++-----
doc/user/error-interaction.rst | 18 +++++++++---------
doc/user/error-list.rst | 2 +-
doc/user/error-reports.rst | 14 +++++++-------
doc/user/flycheck-versus-flymake.rst | 16 ++++++++--------
doc/user/installation.rst | 6 +++---
doc/user/quickstart.rst | 2 +-
doc/user/syntax-checkers.rst | 10 +++++-----
doc/user/syntax-checks.rst | 4 ++--
doc/user/troubleshooting.rst | 8 ++++----
20 files changed, 83 insertions(+), 97 deletions(-)
diff --git a/doc/community/extensions.rst b/doc/community/extensions.rst
index 1efcc999d8..d5d4603d1b 100644
--- a/doc/community/extensions.rst
+++ b/doc/community/extensions.rst
@@ -34,7 +34,7 @@ These extensions change Flycheck’s user interface:
* :flyc:`flycheck-pos-tip` (*official*) shows Flycheck error messages in a
graphical popup.
* :gh:`liblit/flycheck-status-emoji` adds cute emoji (e.g. 😱 for errors) to
- Flycheck’s mode line status.
+ Flycheck’s mode line status.
* :gh:`Wilfred/flycheck-title` shows Flycheck error messages in the frame
title.
* :flyc:`flycheck-inline` shows Flycheck error messages in the buffer, directly
below their origin.
@@ -48,8 +48,8 @@ diagnostics received by the LSP server (by providing a
Flymake backend).
It seems that many people were forced to move to Flymake, because they wanted
to
use Eglot and its maintainer (who's also the maintainer of Flymake) didn't want
-to provide Flycheck integration (backend) for it. (see the relevant `discussion
-<https://github.com/joaotavora/eglot/issues/42>`_))
+to provide Flycheck integration (backend) for it (see the relevant `discussion
+<https://github.com/joaotavora/eglot/issues/42>`_).
Fortunately, you have options if you want to stick with Flycheck:
diff --git a/doc/community/get-help.rst b/doc/community/get-help.rst
index 27ab1e8314..92ff447164 100644
--- a/doc/community/get-help.rst
+++ b/doc/community/get-help.rst
@@ -7,7 +7,7 @@
Please ask questions about Flycheck on `Stack Exchange`_ or in our `Gitter
chat`_. We try to answer all questions as fast and as precise as possible.
-To report bugs and problems please please use our :flyc:`issue tracker
+To report bugs and problems please use our :flyc:`issue tracker
<flycheck/issues>`. Please note that we have a special policy for
:ref:`Windows-only issues <flycheck-windows-issues>`.
diff --git a/doc/community/people.rst b/doc/community/people.rst
index 2ad18b777a..08019635ff 100644
--- a/doc/community/people.rst
+++ b/doc/community/people.rst
@@ -145,7 +145,7 @@ patches and their testing:
.. _Debian Emacs addon team: https://pkg-emacsen.alioth.debian.org/
Acknowledgments
-================
+===============
We would also like to thank the following people and projects:
@@ -167,7 +167,7 @@ We would also like to thank the following people and
projects:
when he was using Vim, and served as inspiration for Flycheck and many of its
syntax checkers.
* Matthias Güdemann (:gh:`mgudemann`), for his invaluable work on
- Flycheck’s logo.
+ Flycheck’s logo.
* Pavel Kobyakov for his work on GNU Flymake, which is a great work on
its own, despite its flaws and weaknesses.
* Simon Carter (:gh:`bbbscarter`), for his patient in-depth testing of
automatic
diff --git a/doc/conf.py b/doc/conf.py
index 7ffbdcbc49..98afd6a59e 100644
--- a/doc/conf.py
+++ b/doc/conf.py
@@ -74,7 +74,7 @@ def read_minimum_emacs_version():
if match:
return match.group(1)
else:
- raise ValueError('Vailed to parse minimum Emacs version from '
+ raise ValueError('Failed to parse minimum Emacs version from '
'Package-Requires of flycheck.el!')
@@ -142,7 +142,7 @@ extlinks = {
}
# While still have work to do :)
-# FIXME: Remove when the old Texinfo manual is completed ported
+# FIXME: Remove when the old Texinfo manual is completely ported
todo_include_todos = True
@@ -222,7 +222,7 @@ class IssueReferences(Transform):
def apply(self):
docname = self.document.settings.env.docname
if docname != 'changes':
- # Only transform issue references in changelo
+ # Only transform issue references in changelog
return
for node in self.document.traverse(nodes.Text):
diff --git a/doc/contributor/contributing.rst b/doc/contributor/contributing.rst
index 94c4812397..57d193b673 100644
--- a/doc/contributor/contributing.rst
+++ b/doc/contributor/contributing.rst
@@ -72,7 +72,7 @@ Feature requests
================
To request a new feature please open a new issue through our `issue form`_.
-A feature request needs to find a core developer or maintainer who adopts and
+A feature request needs to find a core developer or maintainer who adopts and
implements it.
The build system
@@ -90,18 +90,6 @@ Run ``make help`` to see a list of all available targets.
Some common ones are:
- ``make specs`` runs all Buttercup_ specs for Flycheck. Set
:makevar:`PATTERN`
to run only specs matching a specific regular expression, e.g. ``make
PATTERN='^Mode Line' specs`` to run only tests for the mode line.
-- ``make unit`` runs all ERT unit tests for Flycheck. We are phasing ERT out
in
- favour of Buttercup; no new ERT unit tests will be added and this target will
- eventually be removed.
-- ``make integ`` runs all integration tests for Flycheck syntax checkers.
These
- tests are dependent on the checker programs and their versions; expect
- failures when running this target with bleeding-edge checkers. Set
- :makevar:`SELECTOR` to run only tests matching a specific ERT selector,
- e.g. ``make SELECTOR='(language haskell)' integ`` to run only integration
- tests for Haskell. ``make LANGUAGE=haskell integ`` is a shortcut for this.
-
- If you want to replicate the integration tests that are run on the CI,
- continue reading.
.. _Eask: https://emacs-eask.github.io/
.. _Buttercup: https://github.com/jorgenschaefer/emacs-buttercup
@@ -128,7 +116,7 @@ Once the image is built, you can use it to run the
integration tests::
docker run --rm -it -v `pwd`:/flycheck --workdir /flycheck
tools-and-emacs:26.2 /bin/bash -c "make integ"
-Note that the ``all-tools`` image is rebuilt each month, so the versions of the
+Note that the ``all-tools`` image is rebuilt each month, so the versions of
its syntax checkers will change accordingly. You can check the version of each
installed tool by running the ``check-tools`` script in the image::
@@ -147,9 +135,9 @@ Flycheck. Github provides great documentation about `Pull
Requests`_.
Please make your pull requests against the ``master`` branch.
Use ``make check specs unit`` to test your pull request locally. When making
-changes to syntax checkers of a specific language, it’s also a good idea to run
+changes to syntax checkers of a specific language, it’s also a good idea to run
:samp:`make LANGUAGE={language} integ` and check whether the tests for the
-particular language still work. A successful ``make integ`` is by no means
+particular language still work. A successful ``make integ`` is by no means
mandatory for pull requests, though, the continuous integration will test your
changes, too.
@@ -180,13 +168,13 @@ All pull requests go through a two-stage review process:
.. important::
We have a comprehensive :ref:`flycheck-style-guide` that explains what
- features we will accept, how our code should look likewise, what tests we
+ features we will accept, how our code should look like, what tests we
require, how commit messages should look like, and so on.
Take a look at it to see what we look for in a code review.
Additionally all pull requests go through automated tests on `Travis CI`_ which
-check code style, run unit tests, etc
+check code style, run unit tests, etc.
Feel free to mention individual contributors or entire teams
(e.g. ``@flycheck/maintainers`` or ``@flycheck/javascript``) to ask for help or
diff --git a/doc/contributor/maintaining.rst b/doc/contributor/maintaining.rst
index 9a7b1d721c..74c4f36848 100644
--- a/doc/contributor/maintaining.rst
+++ b/doc/contributor/maintaining.rst
@@ -7,7 +7,7 @@
Issue triage
============
-Please label incoming tickets accordingly according to these rules:
+Please label incoming tickets according to these rules:
- Add the “bug” label to things that you think **must be fixed urgently**.
Please don’t use this label for bugs that do not severely impede Flycheck’s
@@ -27,7 +27,7 @@ Please label incoming tickets accordingly according to these
rules:
**If you’d like to review a bug or pull request please assign the corresponding
ticket to you.**
-In issues for specific languages that Flycheck support please mention the
+In issues for specific languages that Flycheck supports please mention the
corresponding :ref:`language team <flycheck-language-teams>` if one exists.
Git workflow
@@ -86,7 +86,7 @@ As a maintainer
* Consider whether you personally think that the change is a good addition to
Flycheck.
-* Weight the expected benefits and impact of the feature against the
+* Weigh the expected benefits and impact of the feature against the
expected complexity.
* Check whether the pull request complies with our :ref:`style guide
<flycheck-style-guide>`, but don't go too much into technical details.
@@ -232,12 +232,12 @@ We use a single continuously increasing version number
for Flycheck.
Breaking changes may occur **at any point**.
-Please feel free to make a release whenever you think it’s appropriate.
-It’s generally a good idea to release when
+Please feel free to make a release whenever you think it’s appropriate.
+It’s generally a good idea to release when
- you fixed an important bug that affects many users,
- there are a couple of new syntax checkers available,
-- there’s a major new feature in ``master``,
+- there’s a major new feature in ``master``,
- etc.
In doubt just make a release. We aim to release early and frequently. If
@@ -256,7 +256,7 @@ First, check that
3. all commits are pushed,
4. and Travis CI passes for the latest commit on ``master``.
-If all is good a new release is a simple as
+If all is good a new release is as simple as
.. code-block:: console
diff --git a/doc/contributor/style-guide.rst b/doc/contributor/style-guide.rst
index c8fd19d8f7..63dd460146 100644
--- a/doc/contributor/style-guide.rst
+++ b/doc/contributor/style-guide.rst
@@ -116,9 +116,8 @@ Tests
:file:`test/specs/`. Check whether the specs fit into an existing spec file,
or add a new file instead. In doubt, use a new file.
-* For new syntax checkers add at least one syntax checker integration test to
- :file:`test/flycheck-test.el`. Make sure that the test passes with
- :samp:`make LANGUAGE={language} integ`.
+* For new syntax checkers add at least one syntax checker test to
+ :file:`test/specs/languages/`.
Documentation
=============
@@ -166,7 +165,7 @@ This model commit message illustrates our style::
The first line is the summary, 50 characters or less. Write in the
imperative and in present tense: “Fix bug”, not “fixed bug” or “fixes
- bug”. Explain the intend of the change not the actual contents which the
+ bug”. Explain the intent of the change not the actual contents which the
diff already provides
After the summary more paragraphs with detailed explanations may follow,
@@ -180,7 +179,7 @@ This model commit message illustrates our style::
like this: Fixes GH-42 and closes GH-42.
`Git Commit`_ and Magit_ provide Emacs mode for Git commit messages, which
helps
-you to comply to these guidelines.
+you to comply with these guidelines.
.. seealso::
diff --git a/doc/developer/developing.rst b/doc/developer/developing.rst
index bb0ab5bba9..328df12a0d 100644
--- a/doc/developer/developing.rst
+++ b/doc/developer/developing.rst
@@ -28,7 +28,7 @@ started (see :ref:`flycheck-syntax-checks`), the following
happens:
the error.
3. Flycheck then filters the collected errors to keep only the relevant ones.
For instance, errors directed at other files than the one you are editing
are
- discarded. The exact sementics of which errors are relevant is defined in
+ discarded. The exact semantics of which errors are relevant is defined in
``flycheck-relevant-error-p``.
4. Relevant errors are highlighted by Flycheck in the buffer, according to user
preference. By default, each error adds a mark in the fringe at the line it
@@ -183,7 +183,7 @@ feedback to the user.
``rx.el`` is a built-in Emacs module for declarative regular expressions.
Look for the documentation of the `rx` function inside Emacs for its usage.
Flycheck extends `rx` with a few constructs like ``line``, ``file-name`` and
- ``message``. You can find them the full list in the docstring for
+ ``message``. You can find the full list in the docstring for
`flycheck-rx-to-string`.
Registering the checker
@@ -298,7 +298,7 @@ XML format, so the definition above uses Flycheck's
built-in CheckStyle parser,
and an ``:error-filter`` to replace ``-`` by the current buffer's filename.
Both checkers use a new ``:predicate`` property to determine when the checker
-can be called. In addition to the ``:mode`` property which restricts the
+can be called. In addition to the ``:modes`` property which restricts the
``protoc`` checker to buffers in ``protobuf-mode``, the ``:predicate`` property
ensures that ``protoc`` is called only when there is a file associated to the
buffer (this is necessary since we are passing the file associated to the
buffer
@@ -364,7 +364,7 @@ The idea is that you know statically one mode that you want
to use the checker
in: ``foobar-mode``, but another mode can be given via the variable
``my-other-foobar-mode`` before the checker is defined. This won't work,
because the ``:modes`` property is auto-quoted by `flycheck-define-checker`.
-The issue arises not just with ``:modes``:, but with almost all the other
+The issue arises not just with ``:modes``, but with almost all the other
properties since they are also auto-quoted.
If you do find yourself in need to define such a checker, there is a solution
diff --git a/doc/glossary.rst b/doc/glossary.rst
index 489f2cb9d3..706b955b32 100644
--- a/doc/glossary.rst
+++ b/doc/glossary.rst
@@ -3,7 +3,7 @@
==========
The glossary explains most of the special terms we use in this documentation.
-some of these are originally explained in the `Emacs manual`_ or the `Emacs
Lisp
+Some of these are originally explained in the `Emacs manual`_ or the `Emacs
Lisp
reference`_, but we reproduce them here for convenience.
.. _Emacs manual:
https://www.gnu.org/software/emacs/manual/html_node/emacs/index.html
@@ -13,7 +13,7 @@ reference`_, but we reproduce them here for convenience.
init file
user init file
- Your main Emacs configuration file. It’s typically located in your
+ Your main Emacs configuration file. It’s typically located in your
:term:`user emacs directory` at :file:`$HOME/.emacs.d/init.el`. Emacs
also looks at :file:`$HOME/.emacs`, but this location is not recommended
anymore. To find out the actual path to your init file of your Emacs
@@ -36,7 +36,7 @@ reference`_, but we reproduce them here for convenience.
at :file:`~/.emacs.d/init.el`.
registered syntax checker
- A syntax checker in `flycheck-checkers`. Flycheck will only use these
+ A syntax checker in `flycheck-checkers`. Flycheck will only use these
syntax checkers when checking buffers automatically.
verification buffer
@@ -49,5 +49,5 @@ reference`_, but we reproduce them here for convenience.
commands. They are named :samp:`flycheck-{checker}-executable`,
e.g. ``flycheck-c/c++-clang-executable`` for `c/c++-clang`.
- Flycheck implicit defines these options for all syntax checkers defined
+ Flycheck implicitly defines these options for all syntax checkers defined
with `flycheck-define-checker`.
diff --git a/doc/index.rst b/doc/index.rst
index 03f73eb844..647101157d 100644
--- a/doc/index.rst
+++ b/doc/index.rst
@@ -46,7 +46,7 @@ run ``M-x eval-buffer``:
(global-flycheck-mode)
-*On MacOS* also add the following to :ref:`fix your $PATH environment variable
+*On macOS* also add the following to :ref:`fix your $PATH environment variable
<flycheck-macos-exec-path-from-shell>`:
.. code-block:: cl
@@ -56,7 +56,7 @@ run ``M-x eval-buffer``:
For a permanent installation of Flycheck follow the :ref:`Installation
<flycheck-installation>` instructions. For a gentle introduction into Flycheck
-features go through :ref:`Quickstart <flycheck-quickstart>` guide.
+features go through the :ref:`Quickstart <flycheck-quickstart>` guide.
.. important::
@@ -74,7 +74,7 @@ The User Guide
The User Guide provides installation and usage help for Flycheck. It starts
with installation instructions and a quick start tutorial and then focuses on
an
-in-depth references of all parts of Flycheck.
+in-depth reference to all parts of Flycheck.
.. toctree::
@@ -93,7 +93,7 @@ in-depth references of all parts of Flycheck.
The Community Guide
===================
-The Community Guide provides information about Flycheck’s ecosystem and
+The Community Guide provides information about Flycheck’s ecosystem and
community.
.. toctree::
@@ -108,7 +108,7 @@ community.
The Developer Guide
===================
-The Developer Guide shows how extend Flycheck and how to write syntax checkers
+The Developer Guide shows how to extend Flycheck and how to write syntax
checkers
for Flycheck.
.. toctree::
diff --git a/doc/languages.rst b/doc/languages.rst
index 4779170f8d..7fe0a74c6b 100644
--- a/doc/languages.rst
+++ b/doc/languages.rst
@@ -639,7 +639,7 @@ to view the docstring of the syntax checker. Likewise, you
may use
.. syntax-checker:: haskell-stack-ghc
haskell-ghc
- Check syntax and type GHC_. In Stack_ projects invoke GHC through Stack
+ Check syntax and types with GHC_. In Stack_ projects invoke GHC through
Stack
to bring package dependencies from Stack in.
.. _GHC: https://www.haskell.org/ghc/
@@ -1036,7 +1036,6 @@ to view the docstring of the syntax checker. Likewise,
you may use
This syntax checker requires PHP Code Sniffer 2.6 or newer.
- .. _PHP Code Sniffer: http://pear.php.net/package/PHP_CodeSniffer
.. _PHPCS Changed: https://github.com/sirbrillig/phpcs-changed
.. defcustom:: flycheck-phpcs-standard
@@ -1083,7 +1082,7 @@ to view the docstring of the syntax checker. Likewise,
you may use
.. syntax-checker:: puppet-lint
- Link with `Puppet Lint <http://puppet-lint.com/>`_.
+ Lint with `Puppet Lint <http://puppet-lint.com/>`_.
.. defcustom:: flycheck-puppet-lint-disabled-checks
@@ -1152,7 +1151,7 @@ to view the docstring of the syntax checker. Likewise,
you may use
.. syntax-checker:: python-pyright
- Type check python with `pyright
<https://github.com/microsoft/pyright>`_.
+ Type check Python with `pyright <https://github.com/microsoft/pyright>`_.
.. note::
@@ -1160,7 +1159,7 @@ to view the docstring of the syntax checker. Likewise,
you may use
.. syntax-checker:: python-mypy
- Type check python with `mypy <http://www.mypy-lang.org/>`_.
+ Type check Python with `mypy <http://www.mypy-lang.org/>`_.
.. note::
diff --git a/doc/user/error-interaction.rst b/doc/user/error-interaction.rst
index e9ed59cb84..29004246f4 100644
--- a/doc/user/error-interaction.rst
+++ b/doc/user/error-interaction.rst
@@ -26,7 +26,7 @@ errors; navigation should just work out of the box.
.. note::
Visible compilation buffers such as buffers from ``M-x compile``, ``M-x
- grep``, etc. still take *precedence* over Flycheck’s errors.
+ grep``, etc. still take *precedence* over Flycheck’s errors.
The exact behaviour of these error navigation features is very
context-dependent
and can be very confusing at times so you can disable this integration:
@@ -70,7 +70,7 @@ compilation buffers and `flycheck-standard-error-navigation`:
Jump to the first Flycheck error.
- With prefix argument, jump forwards to by as many errors as specified by the
+ With prefix argument, jump forwards by as many errors as specified by the
prefix argument, e.g. :kbd:`M-3 M-x flycheck-first-error` moves to the 3rd
error from the beginning of the buffer. With negative prefix argument move
to the last error instead.
@@ -114,7 +114,7 @@ behaviour is entirely customisable:
.. defcustom:: flycheck-display-errors-function
- A function to display errors.
+ A function to display errors.
The function is given the list of Flycheck errors to display as sole
argument
and shall display these errors to the user in some way.
@@ -134,7 +134,7 @@ Flycheck provides two built-in functions for this option:
(setq flycheck-display-errors-function
#'flycheck-display-error-messages-unless-error-list)
-Along the same vein, Flycheck provides a way to customise how a error message
is
+Along the same vein, Flycheck provides a way to customise how an error message
is
cleared, this is especially useful if you use a Flycheck extension to display
error messages differently from the default.
@@ -155,7 +155,7 @@ clear the last Flycheck error message from the minibuffer:
.. seealso::
:flyc:`flycheck-pos-tip`
- A Flycheck extension to display errors in a GUI popup.
+ A Flycheck extension to display errors in a GUI popup.
Additionally Flycheck shows errors in a GUI tooltip whenever you hover an error
location with the mouse pointer. By default the tooltip contains the messages
@@ -163,7 +163,7 @@ and IDs of all errors under the pointer, but the contents
are customisable:
.. defcustom:: flycheck-help-echo-function
- A function to create the contents of the tooltip.
+ A function to create the contents of the tooltip.
The function is given a list of Flycheck errors to display as sole argument
and shall return a single string to use as the contents of the tooltip.
@@ -224,7 +224,7 @@ checkers produce explanations, the majority do not. Those
that do are:
Kill errors
===========
-You can put errors into the kill ring with `C-c ! w`:
+You can put errors into the kill ring with `C-c ! C-w`:
.. define-key:: C-c ! C-w
M-x flycheck-copy-errors-as-kill
@@ -234,9 +234,9 @@ You can put errors into the kill ring with `C-c ! w`:
.. define-key:: C-u C-c ! C-w
C-u M-x flycheck-copy-errors-as-kill
- Like `C-c ! w` but with error IDs.
+ Like `C-c ! C-w` but with error IDs.
.. define-key:: M-0 C-c ! C-w
M-0 M-x flycheck-copy-errors-as-kill
- Like `C-c ! w` but do not copy the error messages but only the error IDs.
+ Like `C-c ! C-w` but do not copy the error messages but only the error IDs.
diff --git a/doc/user/error-list.rst b/doc/user/error-list.rst
index a51c53dcd2..d6232dc674 100644
--- a/doc/user/error-list.rst
+++ b/doc/user/error-list.rst
@@ -42,7 +42,7 @@ Within the error list the following key bindings are
available:
Filter the list
===============
-By the default the error list shows all errors but sometimes you'd like to hide
+By default the error list shows all errors but sometimes you'd like to hide
warnings to focus only on real errors. The error list lets you hide all errors
below a certain level with :kbd:`f`. This key prompts for an error level and
will remove all errors of lower levels from the list. The filter is permanent
diff --git a/doc/user/error-reports.rst b/doc/user/error-reports.rst
index ba7d26a31b..cb3a5826ad 100644
--- a/doc/user/error-reports.rst
+++ b/doc/user/error-reports.rst
@@ -13,7 +13,7 @@ results of the check in the current buffer in two ways:
Additionally Flycheck indicates its current state and the number of errors and
warnings in the mode line.
-The following screenshot illustrates how this looks like in the default Emacs
+The following screenshot illustrates what this looks like in the default Emacs
color theme. It shows an info, a warning and an error annotation, from top to
bottom. Please also note the fringe indicators on the left side and the
emphasized mode line indicator in the bottom right corner:
@@ -76,7 +76,7 @@ using `flycheck-highlighting-mode`.
``symbols``
Highlight the entire symbol around the error column if any, otherwise
like
- ``columns``. This is this default.
+ ``columns``. This is the default.
``sexps``
Highlight the entire expression around the error column if any, otherwise
@@ -118,7 +118,7 @@ is achieved using the ``conditional`` style described
below).
twice to form double brackets.
``(conditional NLINES S1 S2)``
- Chose between styles ``S1`` and ``S2``: ``S1`` if the error covers up to
+ Choose between styles ``S1`` and ``S2``: ``S1`` if the error covers up to
``NLINES``, and ``S2`` otherwise.
To change the style of the underline or use different colours in the
@@ -151,7 +151,7 @@ In GUI frames, Flycheck also adds indicators to the
fringe—the left or right
border of an Emacs window—to help you identify erroneous lines quickly.
These indicators consist of a rightward-pointing double arrow shape coloured in
the colour of the corresponding error level. By default the arrow is 8 pixels
-wide, but a 16 pixels version is used if the fringe is `wide enough
+wide, but a 16-pixel version is used if the fringe is `wide enough
<https://www.gnu.org/software/emacs/manual/html_node/emacs/Fringes.html>`_.
.. note::
@@ -254,7 +254,7 @@ Flycheck’s current state via one of the following texts:
| |<flycheck-languages>` and type `C-c ! v` to see what checkers
|
| |are available for the current buffer.
|
+-------------+----------------------------------------------------------------+
-|``FlyC!`` |The last syntax check failed. Inspect the ``*Messages*``
buffer|
+|``FlyC!`` |The last syntax check failed. Inspect the ``*Messages*``
buffer,|
| |look for error messages, and consider :ref:`reporting a bug
|
| |<flycheck-bug-reports>`.
|
+-------------+----------------------------------------------------------------+
@@ -276,7 +276,7 @@ You can also customize the indicator for a successful run
(no errors/warnings fo
.. defcustom:: flycheck-mode-success-indicator
- Success indicator appended to `flycheck-mode-line-prefix'. Set to ":0" by
default.
+ Success indicator appended to `flycheck-mode-line-prefix`. Set to ":0" by
default.
.. seealso::
@@ -294,7 +294,7 @@ You can also customize the indicator for a successful run
(no errors/warnings fo
Error thresholds
================
-To avoid flooding a buffers with excessive highlighting, cluttering the
+To avoid flooding a buffer with excessive highlighting, cluttering the
appearance and slowing down Emacs, Flycheck takes precautions against syntax
checkers that report a large number of errors exceeding
`flycheck-checker-error-threshold`:
diff --git a/doc/user/flycheck-versus-flymake.rst
b/doc/user/flycheck-versus-flymake.rst
index 7dddd3379c..67547b8f2c 100644
--- a/doc/user/flycheck-versus-flymake.rst
+++ b/doc/user/flycheck-versus-flymake.rst
@@ -102,7 +102,7 @@ contributions to Flymake are subject to the FSF policies on
GNU projects. Most
notably, contributors are required to assign their copyright to the FSF.
**Flycheck** is not part of GNU Emacs. However, it is free software as well,
-and publicly developed on the well-known code hosting platform :gh:`Github
+and publicly developed on the well-known code hosting platform :gh:`GitHub
<flycheck/flycheck>`. Contributing to Flycheck does not require a copyright
assignment, only an explicit agreement that your contributions will be licensed
under the GPL.
@@ -253,7 +253,7 @@ Error explanations
~~~~~~~~~~~~~~~~~~
Some **Flycheck** checkers can use error identifiers to provide error
-explanations in an help buffer (see `flycheck-explain-error-at-point`).
+explanations in a help buffer (see `flycheck-explain-error-at-point`).
.. _margins:
@@ -269,7 +269,7 @@ behavior can be customized using
`flycheck-indication-mode`, and
Error parsing
~~~~~~~~~~~~~
-**Flymake** lets backend parse error messages from
+**Flymake** lets backends parse error messages from
tools. There are no built-in helpers for defining error patterns, or for
parsing JSON or XML formats.
@@ -286,10 +286,10 @@ Error message display
the mouse over an error location, or in the echo area if the user navigates to
the error with `flymake-goto-next-error`.
-**Flycheck** shows error message in tool tips as well, and also displays error
+**Flycheck** shows error messages in tool tips as well, and also displays error
messages in the echo area if the point is at an error location. This feature
is
fully customizable via `flycheck-display-errors-function`, and several
-`extensions <flycheck-extensions>` already provide alternative way to display
+`extensions <flycheck-extensions>` already provide alternative ways to display
errors.
Supported by Eglot
@@ -301,8 +301,8 @@ diagnostics received by the LSP server (by providing a
Flymake backend).
It seems that many people were forced to move to Flymake, because they wanted
to
use Eglot and its maintainer (who's also the maintainer of Flymake) didn't want
-to provide Flycheck integration (backend) for it. (see the relevant `discussion
-<https://github.com/joaotavora/eglot/issues/42>`_))
+to provide Flycheck integration (backend) for it (see the relevant `discussion
+<https://github.com/joaotavora/eglot/issues/42>`_).
.. note::
@@ -315,7 +315,7 @@ Supported by lsp-mode
`lsp-mode <https://github.com/emacs-lsp/lsp-mode>`_ is a popular alternative to
Eglot that supports both Flycheck and Flymake.
-As you might imagine we encourage Flycheck to use ``lsp-mode`` until we find
+As you might imagine we encourage Flycheck users to use ``lsp-mode`` until we
find
some solution for the existing limitations in Eglot.
.. rubric:: Footnotes
diff --git a/doc/user/installation.rst b/doc/user/installation.rst
index f876f32ce9..794ae21cb8 100644
--- a/doc/user/installation.rst
+++ b/doc/user/installation.rst
@@ -41,9 +41,9 @@ package managers such as Rubygems, NPM, Cabal, etc.
.. important::
- For a GUI Emacs on MacOS we recommend to install and configure
+ For a GUI Emacs on macOS we recommend to install and configure
exec-path-from-shell_ to make Emacs use the proper ``$PATH`` and avoid a
- :ref:`common setup issue on MacOS <flycheck-macos-exec-path-from-shell>`.
+ :ref:`common setup issue on macOS <flycheck-macos-exec-path-from-shell>`.
.. _Homebrew: https://brew.sh
.. _exec-path-from-shell: https://github.com/purcell/exec-path-from-shell
@@ -55,7 +55,7 @@ Package installation
We recommend to install Flycheck with Emacs' built-in package manager.
Flycheck
is available in the popular `MELPA`_ archive which serves up to date snapshots
-of Flycheck's development state. We recommend to read through the
+of Flycheck's development state. We recommend to read through the
:doc:`changelog </changes>` before every upgrade to check for any breaking
changes that might affect you.
diff --git a/doc/user/quickstart.rst b/doc/user/quickstart.rst
index 8b7a831ad7..ab4a194256 100644
--- a/doc/user/quickstart.rst
+++ b/doc/user/quickstart.rst
@@ -54,7 +54,7 @@ Navigate and list errors
With `C-c ! n` and `C-c ! p` you can now jump back and forth between erroneous
places. If you keep on such a place for a little while Flycheck will show the
-corresponding error message in the each area. Likewise, if you hover such a
+corresponding error message in the echo area. Likewise, if you hover such a
place with the mouse cursor Flycheck will show the error message in a tooltip.
Press `C-c ! l` to pop up a list of all errors in the current buffer. This
list
diff --git a/doc/user/syntax-checkers.rst b/doc/user/syntax-checkers.rst
index 753342cfe1..2e2412f33b 100644
--- a/doc/user/syntax-checkers.rst
+++ b/doc/user/syntax-checkers.rst
@@ -22,7 +22,7 @@ you can access with `C-c ! ?`:
Prompt for the name of a syntax checker and pop up a Help buffer with its
documentation.
- The documentation includes the name of the program or service used, a list
of
+ The documentation includes the name of the program or service used, a list
of
major modes the checker supports and a list of all options for this syntax
checker.
@@ -36,9 +36,9 @@ buffer from `flycheck-checkers` whenever it needs to check
the buffer:
.. defcustom:: flycheck-checkers
- A list of all syntax checkers available for syntax checking.
+ A list of all syntax checkers available for syntax checking.
- A syntax checker in this list is a :term:`registered syntax checker`.
+ A syntax checker in this list is a :term:`registered syntax checker`.
Flycheck picks the first syntax checker from this list which exists and
supports
the current major mode, and runs it over the current buffer. When the checker
@@ -112,7 +112,7 @@ a specific syntax checker for a project. For instance,
Flycheck usually prefers
`javascript-jshint` instead you can tell Flycheck to use `javascript-jshint`
for
all Javascript buffers of your project with the following command in the
top-level directory of your project: :kbd:`M-x add-dir-local-variable RET
-js-mode RET flycheck-checker RET javascript-jshint`. A new buffer pops up that
+js-mode RET flycheck-checker RET javascript-jshint`. A new buffer pops up that
shows the newly created entry in the directory variables. Save this buffer and
kill it. From now on Flycheck will check all Javascript files of this project
with JSHint.
@@ -287,7 +287,7 @@ reported, the next checker of the sequence runs and its
errors are reported,
etc. until there are no more checkers in the sequence. This sequence is called
a *checker chain*.
-Some checkers chains are already setup by default in Flycheck: e.g.,
+Some checker chains are already set up by default in Flycheck: e.g.,
`emacs-lisp` will be followed by `emacs-lisp-checkdoc`, and `python-mypy` will
be followed by `python-flake8`.
diff --git a/doc/user/syntax-checks.rst b/doc/user/syntax-checks.rst
index 9130b92abb..c443b8329b 100644
--- a/doc/user/syntax-checks.rst
+++ b/doc/user/syntax-checks.rst
@@ -50,7 +50,7 @@ possible.
i.e. whenever the value of ``major-mode`` is contained in this list.
:samp:`(not {foo-mode} …)`
- Turn :mode:`flycheck` on for all major nodes *not* in this list,
+ Turn :mode:`flycheck` on for all major modes *not* in this list,
i.e. whenever the value of ``major-mode`` is *not* contained in this
list.
@@ -83,7 +83,7 @@ You can customise this behaviour with
`flycheck-check-syntax-automatically`:
.. defcustom:: flycheck-check-syntax-automatically
- A list of events which trigger a syntax check in the current buffer:
+ A list of events which trigger a syntax check in the current buffer:
``save``
Check the buffer immediately after it was saved.
diff --git a/doc/user/troubleshooting.rst b/doc/user/troubleshooting.rst
index 87f950376c..470b6040cf 100644
--- a/doc/user/troubleshooting.rst
+++ b/doc/user/troubleshooting.rst
@@ -16,13 +16,13 @@ First check whether your issue is one of the common setup
issues and problems.
.. _flycheck-macos-exec-path-from-shell:
-Flycheck can’t find any programs in GUI Emacs on MacOS
+Flycheck can’t find any programs in GUI Emacs on macOS
------------------------------------------------------
Try to install and configure exec-path-from-shell_ to make a GUI Emacs inherit
the ``$PATH`` environment variable from your shell configuration.
-The issue is that due to the special way MacOS starts GUI programs a GUI Emacs
+The issue is that due to the special way macOS starts GUI programs a GUI Emacs
does not inherit the environment variables from the shell configuration so
Emacs
will lack some important entries in ``$PATH``, most notably ``/usr/local/bin/``
where Homebrew, NPM and many other package managers put binaries in.
@@ -105,12 +105,12 @@ syntax checker just the way Flycheck would run it:
.. define-key:: C-c ! C-c
M-x flycheck-compile
- Prompt for a syntax checker and run in as a shell command, showing the whole
+ Prompt for a syntax checker and run it as a shell command, showing the whole
output in a separate buffer.
.. important::
- The current implementation this command suffers from a couple of issues,
+ The current implementation of this command suffers from a couple of
issues,
so we’d like to have a replacement in GH-854_ and we could use your help!
If you’d like to help out with this task please join the discussion in
that issue.
