Skip to content

Commit e3817af

Browse files
committed
Add and correct information on pyupgrade usage
1 parent d87f2fe commit e3817af

File tree

2 files changed

+9
-5
lines changed

2 files changed

+9
-5
lines changed

doc/changes/unreleased.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@
44

55
* #589: Corrected configuration for Sonar documentation for host.url
66
* #535: Added more information about Sonar's usage of ``exclusions``
7+
* #589: Corrected and added more information regarding ``pyupgrade``
78

89
## Refactoring
910

doc/user_guide/features/formatting_code/index.rst

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -44,6 +44,7 @@ deterministic manner.
4444

4545
Configuration
4646
+++++++++++++
47+
4748
black
4849
^^^^^
4950

@@ -59,6 +60,7 @@ For further configuration options, see
5960

6061
isort
6162
^^^^^
63+
6264
Ensure ``isort`` is configured with compatibility for ``black``:
6365

6466
.. literalinclude:: ../../../../project-template/{{cookiecutter.repo_name}}/pyproject.toml
@@ -72,9 +74,10 @@ For further configuration options, see
7274

7375
pyupgrade
7476
^^^^^^^^^
75-
No initial configuration of ``pyupgrade`` is required.
7677

77-
For individual configuration, see the
78-
`pyupgrade CLI options <https://pypi.org/project/pyupgrade/>`__. These can
79-
be passed to the :ref:`formatting_sessions` via the ``pyupgrade_args``
80-
attribute of the :class:`noxconfig.Config`.
78+
No initial configuration of ``pyupgrade`` is required. By default, this is
79+
configured to be derived from the minimum Python version that your project supports
80+
and is defined in the :meth:`exasol.toolbox.config.BaseConfig.pyupgrade_argument`.
81+
82+
For further configuration options, see the
83+
`pyupgrade documentation <https://pypi.org/project/pyupgrade/>`__.

0 commit comments

Comments
 (0)