mirrors/uv
1
0
Fork 0
mirror of https://github.com/astral-sh/uv.git synced 2025-08-04 19:08:04 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 2

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
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
42 changed files with 711 additions and 646 deletions
Download patch file Download diff file Expand all files Collapse all files

8
docs/concepts/workspaces.md
View file

@ -4,9 +4,9 @@ Workspaces help organize large codebases by splitting them into multiple package
dependencies.
When using the `uv pip` interface, workspace dependencies behave like automatic editable path
dependencies. Using the uv project interface, all of the workspace packages are locked together. `uv
run` installs only the current package (unless overridden with `--package`) and its workspace and
non-workspace dependencies.
dependencies. Using the uv project interface, all of the workspace packages are locked together.
`uv run` installs only the current package (unless overridden with `--package`) and its workspace
and non-workspace dependencies.
## Configuration
@ -25,7 +25,7 @@ in the `tool.uv.sources` of a specific project.
## Common structures
There a two main workspace structures: A **root package with helpers** and a **flat workspace**.
There a two main workspace structures: A **root package with helpers** and a **flat workspace**.
The root workspace layout defines one main package in the root of the repository, with helper
packages in `packages`. In this example `albatross/pyproject.toml` has both a `project` section and