Skip to content

Commit

Permalink
Separate use cases from non-use cases of workspaces
Browse files Browse the repository at this point in the history
Partially address astral-sh#5605 (comment)
  • Loading branch information
astrojuanlu authored Nov 3, 2024
1 parent bf79d98 commit 56c797e
Showing 1 changed file with 3 additions and 1 deletion.
4 changes: 3 additions & 1 deletion docs/concepts/workspaces.md
Original file line number Diff line number Diff line change
Expand Up @@ -147,7 +147,7 @@ albatross
Since `seeds` was excluded in the `pyproject.toml`, the workspace has two members total: `albatross`
(the root) and `bird-feeder`.

## When (not) to use workspaces
## Summary of use cases

Workspaces are intended to facilitate the development of multiple interconnected packages within a
single repository. As a codebase grows in complexity, it can be helpful to split it into smaller,
Expand All @@ -164,6 +164,8 @@ Other common use cases for workspaces include:
- A library with a plugin system, where each plugin is a separate workspace package with a
dependency on the root.

## When _not_ to use workspaces

Workspaces are _not_ suited for cases in which members have conflicting requirements, or desire a
separate virtual environment for each member. In this case, path dependencies are often preferable.
For example, rather than grouping `albatross` and its members in a workspace, you can always define
Expand Down

0 comments on commit 56c797e

Please sign in to comment.