Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Edit wording in workspaces.md #1395

Merged
merged 1 commit into from
Sep 29, 2024
Merged

Edit wording in workspaces.md #1395

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 9 additions & 9 deletions docs/guide/workspaces.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,15 +1,15 @@
# Workspaces

Workspaces are a feature that allows you to work with multiple packages that
have dependencies to each other. A workspace is declared by setting the
`tool.rye.workspace` key a `pyproject.toml`. Afterwards all projects within
have dependencies on each other. A workspace is declared by setting the
`tool.rye.workspace` key in `pyproject.toml`. Afterwards, all projects within
that workspace share a singular virtualenv.

## Declaring Workspaces

A workspace is declared by the "toplevel" `pyproject.toml`. At the very least
the key `tool.rye.workspace` needs to be added. It's recommended that a glob
pattern is also set in the `members` key to prevent accidentally including
A workspace is declared in the "toplevel" `pyproject.toml`. At the very least
the key `tool.rye.workspace` needs to be added. It's also recommended to
set a glob pattern in the `members` key to prevent accidentally including
unintended folders as projects.

```toml
Expand All @@ -18,7 +18,7 @@ members = ["myname-*"]
```

This declares a workspace where all folders starting with the name `myname-`
are considered. If the toplevel workspace in itself should not be a project,
are considered. If the toplevel workspace itself should not be a project,
then it should be declared as a virtual package:

```toml
Expand All @@ -29,12 +29,12 @@ virtual = true
members = ["myname-*"]
```

For more information on that see [Virtual Packages](../virtual/).
For more information on that, see [Virtual Packages](../virtual/).

## Syncing

In a workspace it does not matter which project you are working with, the entire
workspace is synchronized at all times. This has some untypical consequences but
In a workspace, it does not matter which project you are working with, the entire
workspace is synchronized at all times. This has some atypical consequences but
simplifies the general development workflow.

When a package depends on another package it's first located in the workspace locally
Expand Down