Skip to content

Commit

Permalink
Update the README file
Browse files Browse the repository at this point in the history
  • Loading branch information
akaihola committed Jan 14, 2023
1 parent 038aa2c commit 48db90d
Showing 1 changed file with 8 additions and 0 deletions.
8 changes: 8 additions & 0 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,7 @@ The reformatters supported are:

- Black_ for code reformatting
- isort_ for sorting imports
- flynt_ for turning old-style format strings to f-strings

See `Using linters`_ below for the list of supported linters.

Expand All @@ -53,6 +54,7 @@ see the relevant sections below in this document.

.. _Black: https://github.com/python/black
.. _isort: https://github.com/timothycrosley/isort
.. _flynt: https://github.com/ikamensh/flynt
.. _Pytest: https://docs.pytest.org/
.. _pytest-darker: https://pypi.org/project/pytest-darker/

Expand Down Expand Up @@ -164,10 +166,13 @@ You can enable additional features with command line options:
- ``-i`` / ``--isort``: Reorder imports using isort_. Note that isort_ must be
run in the same Python environment as the packages to process, as it imports
your modules to determine whether they are first or third party modules.
- ``-f`` / ``--flynt``: Also convert string formatting to use f-strings using the
``flynt`` package
- ``-L <linter>`` / ``--lint <linter>``: Run a supported linter (see `Using linters`_)

*New in version 1.1.0:* The ``-L`` / ``--lint`` option.
*New in version 1.2.2:* Package available in conda-forge_.
*New in version 1.7.0:* The ``-f`` / ``--flynt`` option

.. _Conda: https://conda.io/
.. _conda-forge: https://conda-forge.org/
Expand Down Expand Up @@ -367,6 +372,7 @@ project's root directory, or to a different TOML file specified using the ``-c``
diff = true
check = true
isort = true
flynt = true
lint = [
"pylint",
]
Expand Down Expand Up @@ -423,6 +429,8 @@ command line options

*New in version 1.7.0:* The ``-t`` / ``--target-version`` command line option

*New in version 1.7.0:* The ``-f`` / ``--flynt`` command line option

.. _Black documentation about pyproject.toml: https://black.readthedocs.io/en/stable/usage_and_configuration/the_basics.html#configuration-via-a-file
.. _isort documentation about config files: https://timothycrosley.github.io/isort/docs/configuration/config_files/
.. _public GitHub repositories which install and run Darker: https://github.com/search?q=%2Fpip+install+.*darker%2F+path%3A%2F%5E.github%5C%2Fworkflows%5C%2F.*%2F&type=code
Expand Down

0 comments on commit 48db90d

Please sign in to comment.