branch: elpa/flycheck
commit 24f7961878597cf79cde415046c9726d98098263
Author: Bozhidar Batsov <[email protected]>
Commit: Bozhidar Batsov <[email protected]>
Fix documentation out of sync with code
- languages.rst: Update intro paragraphs for Coffeescript (remove
reference to removed coffee-coffeelint), Javascript (add oxlint),
Python (add ruff, pyright, mypy), Ruby (add ruby-standard)
- error-interaction.rst: Remove nix-linter from explainer list, add
python-ruff
- developing.rst: Fix variable name mismatch in shellcheck example,
fix %S to %s in URL format string
- style-guide.rst, contributing.rst: Update Emacs version from 25 to
27.1
- CHANGES.rst: Fix python-ruff format entry (text/concise were swapped)
---
CHANGES.rst | 4 ++--
doc/contributor/contributing.rst | 2 +-
doc/contributor/style-guide.rst | 4 ++--
doc/developer/developing.rst | 6 +++---
doc/languages.rst | 19 ++++++++++---------
doc/user/error-interaction.rst | 2 +-
6 files changed, 19 insertions(+), 18 deletions(-)
diff --git a/CHANGES.rst b/CHANGES.rst
index 41f9ff86af..c19bf2fffa 100644
--- a/CHANGES.rst
+++ b/CHANGES.rst
@@ -79,8 +79,8 @@ Bugs fixed
``gawk --source``.
- [#2092]: Detect parse errors (unbalanced parentheses, invalid read syntax)
in ``emacs-lisp`` byte compilation.
-- Fix ``python-ruff`` checker to use ``text`` output format instead of
- removed ``concise`` format.
+- Fix ``python-ruff`` checker to use ``concise`` output format instead of
+ removed ``text`` format (renamed in ruff 0.2).
- Fix ``python-ruff`` error ID regex and ``invalid-syntax`` error handling.
-------
diff --git a/doc/contributor/contributing.rst b/doc/contributor/contributing.rst
index 7b4e1644dc..aa6f79d951 100644
--- a/doc/contributor/contributing.rst
+++ b/doc/contributor/contributing.rst
@@ -84,7 +84,7 @@ Run ``make help`` to see a list of all available targets.
Some common ones are:
- ``make init`` initialises the project by installing local Emacs Lisp
dependencies.
-- ``make check`` checks all Emacs Lisp sources. This target requires Emacs 25.
+- ``make check`` checks all Emacs Lisp sources. This target requires Emacs
27.1.
- ``make compile`` compiles Flycheck and its libraries to byte code.
- ``make format`` formats all Emacs Lisp sources.
- ``make specs`` runs all Buttercup_ specs for Flycheck. Set
:makevar:`PATTERN`
diff --git a/doc/contributor/style-guide.rst b/doc/contributor/style-guide.rst
index 63dd460146..c852606668 100644
--- a/doc/contributor/style-guide.rst
+++ b/doc/contributor/style-guide.rst
@@ -56,10 +56,10 @@ Style
.. important::
- ``make check compile`` must pass on Emacs 25 or newer. This command checks
+ ``make check compile`` must pass on Emacs 27.1 or newer. This command
checks
for some formatting issues and compilation errors.
- Run ``make format`` with Emacs 25 to automatically reformat the Emacs Lisp
+ Run ``make format`` with Emacs 27.1 to automatically reformat the Emacs Lisp
source files.
* Generally try to fit into the style of the code you see.
diff --git a/doc/developer/developing.rst b/doc/developer/developing.rst
index 567cdf1619..a9301589e1 100644
--- a/doc/developer/developing.rst
+++ b/doc/developer/developing.rst
@@ -265,15 +265,15 @@ Here are two examples of more complex checkers:
:predicate (lambda () (memq sh-shell '(bash ksh88 sh)))
:verify
(lambda (_)
- (let ((supported (memq sh-shell '(bash ksh88 sh))))
+ (let ((supports-shell (memq sh-shell '(bash ksh88 sh))))
(list (flycheck-verification-result-new
:label (format "Shell %s supported" sh-shell)
- :message (if supported "yes" "no")
+ :message (if supports-shell "yes" "no")
:face (if supports-shell 'success '(bold warning))))))
:error-explainer
(lambda (err)
(let ((error-code (flycheck-error-id err))
- (url "https://github.com/koalaman/shellcheck/wiki/%S";))
+ (url "https://github.com/koalaman/shellcheck/wiki/%s";))
(and error-code `(url . ,(format url error-code))))))
The ``:command`` forms are longer, as the checkers pass more flags to
``protoc``
diff --git a/doc/languages.rst b/doc/languages.rst
index e224e80a6a..83c14d36cb 100644
--- a/doc/languages.rst
+++ b/doc/languages.rst
@@ -223,8 +223,7 @@ to view the docstring of the syntax checker. Likewise, you
may use
.. supported-language:: Coffeescript
- Flycheck checks Coffeescript syntax with `coffee` and then lints with
- `coffee-coffeelint`.
+ Flycheck checks Coffeescript syntax with `coffee`.
.. syntax-checker:: coffee
@@ -671,7 +670,7 @@ to view the docstring of the syntax checker. Likewise, you
may use
.. supported-language:: Javascript
- Flycheck checks Javascript with `javascript-eslint`.
+ Flycheck checks Javascript with `javascript-eslint` or `javascript-oxlint`.
Alternatively `javascript-standard` is used instead.
@@ -1023,8 +1022,10 @@ to view the docstring of the syntax checker. Likewise,
you may use
.. supported-language:: Python
- Flycheck checks Python with `python-flake8` or `python-pylint`, and falls
- back to `python-pycompile` if neither of those is available.
+ Flycheck checks Python with `python-flake8`, `python-ruff` or
+ `python-pylint`, and falls back to `python-pycompile` if none of those
+ is available. Additionally `python-pyright` and `python-mypy` provide
+ optional type checking.
All Python checkers are invoked indirectly using ``python -c ...`` (rather
than a direct call to ``flake8`` or ``pylint``) to make it easier to switch
@@ -1192,10 +1193,10 @@ to view the docstring of the syntax checker. Likewise,
you may use
.. supported-language:: Ruby
- Flycheck checks Ruby with `ruby-rubocop` and `ruby-reek`,
- falling back to `ruby` for basic syntax checking if those are not
- available. There's also `ruby-chef-cookstyle`, which is only used
- for Chef cookbooks.
+ Flycheck checks Ruby with `ruby-rubocop` (or `ruby-standard`) and
+ `ruby-reek`, falling back to `ruby` for basic syntax checking if those
+ are not available. There's also `ruby-chef-cookstyle`, which is only
+ used for Chef cookbooks.
.. syntax-checker:: ruby-rubocop
diff --git a/doc/user/error-interaction.rst b/doc/user/error-interaction.rst
index 29004246f4..28944513c3 100644
--- a/doc/user/error-interaction.rst
+++ b/doc/user/error-interaction.rst
@@ -206,9 +206,9 @@ checkers produce explanations, the majority do not. Those
that do are:
* `javascript-eslint`
* `markdown-markdownlint-cli`
* `markdown-markdownlint-cli2`
-* `nix-linter`
* `perl-perlcritic`
* `python-pylint`
+* `python-ruff`
* `rpm-rpmlint`
* `rust`
* `rust-cargo`
