Python/uv
1
0
Fork 0
mirror of https://github.com/astral-sh/uv synced 2026-01-10 08:03:23 -05:00
Code Issues Packages Projects Releases Wiki Activity

Use prettier to format the documentation (#5708)

Browse Source 
To enforce the 100 character line limit in markdown files introduced in
https://github.com/astral-sh/uv/pull/5635, and to automate the
formatting of markdown files, i've added prettier and formatted our
markdown files with it.

I've excluded the changelog and the generated references documentation
from this for having too many changes, but we can also include them.

I'm not particular on which style we use. My main motivations are
(major) not having to reflow markdown files myself anymore and (minor)
consistence between all markdown files. I've chosen prettier for similar
reason as we chose black, it's a single good style that's automated and
shared in the community. I do prefer prettier's style of not breaking
inside of a link name though.

This PR is in two parts, the first adds prettier to CI and documents
using it, while the second actually formats the docs. When merge
conflicts arise, we can drop the last commit and regenerate it with `npx
prettier --prose-wrap always --write BENCHMARKS.md CONTRIBUTING.md
README.md STYLE.md docs/*.md docs/concepts/**/*.md docs/guides/**/*.md
docs/pip/**/*.md`.

---------

Co-authored-by: Zanie Blue <contact@zanie.dev>
This commit is contained in:
konsti
2024-08-02 15:58:31 +02:00
committed by GitHub
parent f2c4b9c752
commit db371560bc
42 changed files with 711 additions and 646 deletions
Download Patch File Download Diff File Expand all files Collapse all files

11
docs/guides/install-python.md
View File

@@ -1,8 +1,8 @@
# Installing Python
If Python is already installed on your system, uv will [detect and
use](#using-an-existing-python-installation) it without configuration. However, uv can also install
and manage Python versions for you.
If Python is already installed on your system, uv will
[detect and use](#using-an-existing-python-installation) it without configuration. However, uv can
also install and manage Python versions for you.
!!! tip
@@ -21,7 +21,6 @@ system.
Python does not publish official distributable binaries so uv uses third-party distributions from the [`python-build-standalone`](https://github.com/indygreg/python-build-standalone) project. The project is partially maintained by the uv maintainers and is used by many other Python projects. See the [Python distributions](../concepts/python-versions.md#python-distributions) documentation for more details.
<!-- TODO(zanieb): Restore when Python shim management is added
Note that when an automatic Python installation occurs, the `python` command will not be added to the shell. Use `uv python install-shim` to ensure the `python` shim is installed.
@@ -86,8 +85,8 @@ Note that when an automatic Python installation occurs, the `python` command wil
uv will also use an existing Python installation if already present on your system. There is no
configuration necessary for this behavior: uv will use the system Python if it satisfies the
requirements of the command invocation. See the [Python
discovery](../concepts/python-versions.md#discovery-order) documentation for details.
requirements of the command invocation. See the
[Python discovery](../concepts/python-versions.md#discovery-order) documentation for details.
To force uv to use the system Python, provide the `--python-preference only-system` option. See the
[Python version preference](../concepts/python-versions.md#adjusting-python-version-preferences)