Skip to content

Commit 27768f6

Browse files
Fix whitespace and grammar (#1068)
1 parent dcb1d84 commit 27768f6

1 file changed

Lines changed: 6 additions & 21 deletions

File tree

docs/faq.md

Lines changed: 6 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -12,33 +12,18 @@ Some configuration is necessary to ensure smooth integrations with other tools.
1212

1313
## Why does usethis make formatting changes to my config files?
1414

15-
When modifying files like `pyproject.toml` and `.pre-commit-config.yaml`, usethis
16-
attempts to preserve the original formatting as much as possible.
15+
When modifying files like `pyproject.toml` and `.pre-commit-config.yaml`, usethis attempts to preserve the original formatting as much as possible.
1716

18-
However, there are some known limitations for YAML files. In Python, there is currently
19-
no YAML parser with pure round-trip support. The closest is `ruamel.yaml`, but it has
20-
some known limitations. If you find that usethis has modified your files in a way
21-
that you did not expect, please open an issue on the usethis GitHub repository, and
22-
if necessary the issue can be escalated to the `ruamel.yaml` repository on SourceForge,
23-
or other appropriate repository.
17+
However, there are some known limitations for YAML files. In Python, there is currently no YAML parser with pure round-trip support. The closest is `ruamel.yaml`, but it has some known limitations. If you find that usethis has modified your files in a way that you did not expect, please open an issue on the usethis GitHub repository, and if necessary the issue can be escalated to the `ruamel.yaml` repository on SourceForge, or another appropriate repository.
2418

2519
## Is uv absolutely necessary to use usethis?
2620

27-
No, although it is highly recommended for new projects, since it is a modern and
28-
easy-to-use tool for managing Python projects. If you don't have uv installed, usethis
29-
will automatically avoid using it.
21+
No, although it is highly recommended for new projects, since it is a modern and easy-to-use tool for managing Python projects. If you don't have uv installed, usethis will automatically avoid using it.
3022

31-
If you have uv installed but you want to avoid using it for a specific project, you
32-
should use the `--backend=none` option when running usethis commands. In the future,
33-
it is planned that usethis will support additional backends for managing Python
34-
projects, for example Poetry.
23+
If you have uv installed but you want to avoid using it for a specific project, you should use the `--backend=none` option when running usethis commands. In the future, it is planned that usethis will support additional backends for managing Python projects, for example Poetry.
3524

36-
There is another reason to use uv, which is to provide the uvx command for running
37-
usethis. This provides an easy way to use usethis without needing to know technical
38-
details about Python virtual environments.
25+
There is another reason to use uv, which is to provide the uvx command for running usethis. This provides an easy way to use usethis without needing to know technical details about Python virtual environments.
3926

4027
## What if I'm using Poetry for my project?
4128

42-
If you're using Poetry, usethis will automatically detect this and avoid using the uv
43-
backend to install packages. You'll get instructions in the console about which
44-
steps to take manually using Poetry. First-class support for Poetry is planned.
29+
If you're using Poetry, usethis will automatically detect this and avoid using the uv backend to install packages. You'll get instructions in the console about which steps to take manually using Poetry. First-class support for Poetry is planned.

0 commit comments

Comments
 (0)