From 75b3cfde64a457addffe6c2df572ea899654d19b Mon Sep 17 00:00:00 2001 From: Sylvestre Ledru Date: Wed, 16 Oct 2019 07:50:52 +0000 Subject: [PATCH] Bug 1588523 - Document the autofix when existing r=ahal Depends on D49161 Differential Revision: https://phabricator.services.mozilla.com/D49162 --HG-- extra : moz-landing-system : lando --- tools/lint/docs/linters/eslint.rst | 6 ++++++ tools/lint/docs/linters/flake8.rst | 7 +++++++ 2 files changed, 13 insertions(+) diff --git a/tools/lint/docs/linters/eslint.rst b/tools/lint/docs/linters/eslint.rst index d1cd130381f3..05face35ede9 100644 --- a/tools/lint/docs/linters/eslint.rst +++ b/tools/lint/docs/linters/eslint.rst @@ -28,6 +28,12 @@ overridden by including an ``.eslintrc`` in the appropriate subdirectory. For an supported configuration, see `ESLint's documentation`_. +Autofix +------- + +The eslint linter provides a ``--fix`` option. It is based on the upstream option. + + ESLint Plugin Mozilla --------------------- diff --git a/tools/lint/docs/linters/flake8.rst b/tools/lint/docs/linters/flake8.rst index ead4d50a67ca..d726911aaccc 100644 --- a/tools/lint/docs/linters/flake8.rst +++ b/tools/lint/docs/linters/flake8.rst @@ -42,9 +42,16 @@ be re-defined. For an overview of the supported configuration, see `flake8's documentation`_. +Autofix +------- + +The flake8 linter provides a ``--fix`` option. It is based on `autopep8`_. +Please note that autopep8 does NOT fix all issues reported by flake8. + .. _Flake8: https://flake8.readthedocs.io/en/latest/ .. _pep8: http://pep8.readthedocs.io/en/latest/ .. _pyflakes: https://github.com/pyflakes/pyflakes .. _mccabe: https://github.com/pycqa/mccabe .. _bug 1277851: https://bugzilla.mozilla.org/show_bug.cgi?id=1277851 .. _flake8's documentation: https://flake8.readthedocs.io/en/latest/config.html +.. _autopep8: https://github.com/hhatto/autopep8