Bug 1588523 - Document the autofix when existing r=ahal
authorSylvestre Ledru <sledru@mozilla.com>
Wed, 16 Oct 2019 07:50:52 +0000
changeset 559137 e98baddfa8895c6576dbada22316b30aca28f4a4
parent 559136 42be3322aeab1bebf0451ea85e0a6439843aa305
child 559138 50cad137801425d40d70b65b43ef573db0e3755e
push id12175
push userccoroiu@mozilla.com
push dateThu, 17 Oct 2019 19:29:09 +0000
treeherdermozilla-beta@d333b6ef1fd3 [default view] [failures only]
perfherder[talos] [build metrics] [platform microbench] (compared to previous push)
reviewersahal
bugs1588523
milestone71.0a1
first release with
nightly linux32
nightly linux64
nightly mac
nightly win32
nightly win64
last release without
nightly linux32
nightly linux64
nightly mac
nightly win32
nightly win64
Bug 1588523 - Document the autofix when existing r=ahal Depends on D49161 Differential Revision: https://phabricator.services.mozilla.com/D49162
tools/lint/docs/linters/eslint.rst
tools/lint/docs/linters/flake8.rst
--- a/tools/lint/docs/linters/eslint.rst
+++ b/tools/lint/docs/linters/eslint.rst
@@ -23,16 +23,22 @@ The `ESLint`_ mozilla-central integratio
 linted. This lives in ``topsrcdir/.eslintignore``. If you don't wish your directory to be linted, it
 must be added here.
 
 The global configuration file lives in ``topsrcdir/.eslintrc``. This global configuration can be
 overridden by including an ``.eslintrc`` in the appropriate subdirectory. For an overview of the
 supported configuration, see `ESLint's documentation`_.
 
 
+Autofix
+-------
+
+The eslint linter provides a ``--fix`` option. It is based on the upstream option.
+
+
 ESLint Plugin Mozilla
 ---------------------
 
 In addition to default ESLint rules, there are several Mozilla-specific rules that are defined in
 the :doc:`Mozilla ESLint Plugin <eslint-plugin-mozilla>`.
 
 ESLint Plugin SpiderMonkey JS
 -----------------------------
--- a/tools/lint/docs/linters/flake8.rst
+++ b/tools/lint/docs/linters/flake8.rst
@@ -37,14 +37,21 @@ be re-defined.
 
 .. warning::
 
     Only ``.flake8`` files that live in a directory that is explicitly included in the ``include``
     directive will be considered. See `bug 1277851`_ for more details.
 
 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