Skip to content

Commit 57af702

Browse files
committed
Add a warning to "Fallback behavior" doc snippet
Add a warning noting that the "Fallback behavior" doc snippet does not provide a good example of what projects put in `pyproject.toml` and instead link to the respective setuptools documentation. In my experience, more than one project has either copied the snippets verbatim, or incorrectly included `wheel` in their `requires` based on it.
1 parent 4ac0d3d commit 57af702

File tree

2 files changed

+10
-0
lines changed

2 files changed

+10
-0
lines changed

docs/html/reference/build-system/pyproject-toml.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -130,6 +130,13 @@ dealing with [the same challenges as pip has for legacy builds](build-output).
130130

131131
## Fallback Behaviour
132132

133+
```{warning}
134+
The following snippet merely describes the fallback behavior. For valid
135+
examples of `pyproject.toml` to use with setuptools, please refer to
136+
[the setuptools documentation](
137+
https://setuptools.pypa.io/en/stable/userguide/quickstart.html#basic-use).
138+
```
139+
133140
If a project does not have a `pyproject.toml` file containing a `build-system`
134141
section, it will be assumed to have the following backend settings:
135142

news/12122.doc.rst

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
Add a warning explaining that the snippet in "Fallback behavior" is not a valid
2+
``pyproject.toml`` snippet for projects, and link to setuptools documentation
3+
instead.

0 commit comments

Comments
 (0)