Skip to content

Commit

Permalink
Edits wording in workspaces.md
Browse files Browse the repository at this point in the history
  • Loading branch information
oerd committed Sep 25, 2024
1 parent a928cd5 commit 66d9273
Showing 1 changed file with 9 additions and 9 deletions.
18 changes: 9 additions & 9 deletions docs/guide/workspaces.md
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

0 comments on commit 66d9273

Please sign in to comment.