Skip to content

Commit

Permalink
Document sorter config option
Browse files Browse the repository at this point in the history
ghstack-source-id: 4b939138d768d03d6f5bcb9d89f6dcf8f0a31b65
Pull Request resolved: #195
  • Loading branch information
amyreese committed Feb 22, 2024
1 parent 1d583fd commit f281dc0
Showing 1 changed file with 18 additions and 1 deletion.
19 changes: 18 additions & 1 deletion docs/guide.rst
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,24 @@ Options available are described as follows:
:caption: pyproject.toml
[tool.ufmt]
formatter = "ruff"
formatter = "ruff-api"
See :class:`~ufmt.types.Formatter` for list of supported choices.

.. attribute:: sorter
:type: str
:value: "usort"

**Experimental** option to use an alternative sorter instead of µsort.
Changing this selection is likely to generate different formatting results
as compared to µsort, especially depending on available or pinned versions
of each formatter in µfmt's environment.

.. code-block:: toml
:caption: pyproject.toml
[tool.ufmt]
sorter = "usort"
See :class:`~ufmt.types.Formatter` for list of supported choices.

Expand Down

0 comments on commit f281dc0

Please sign in to comment.