Skip to content

Commit

Permalink
Merge pull request #12122 from mgorny/fallback-warning
Browse files Browse the repository at this point in the history
Add a warning to "Fallback behavior" doc snippet
  • Loading branch information
pfmoore authored Apr 20, 2024
2 parents e203e31 + 57af702 commit 491846b
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 0 deletions.
7 changes: 7 additions & 0 deletions docs/html/reference/build-system/pyproject-toml.md
Original file line number Diff line number Diff line change
Expand Up @@ -130,6 +130,13 @@ dealing with [the same challenges as pip has for legacy builds](build-output).

## Fallback Behaviour

```{warning}
The following snippet merely describes the fallback behavior. For valid
examples of `pyproject.toml` to use with setuptools, please refer to
[the setuptools documentation](
https://setuptools.pypa.io/en/stable/userguide/quickstart.html#basic-use).
```

If a project does not have a `pyproject.toml` file containing a `build-system`
section, it will be assumed to have the following backend settings:

Expand Down
3 changes: 3 additions & 0 deletions news/12122.doc.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
Add a warning explaining that the snippet in "Fallback behavior" is not a valid
``pyproject.toml`` snippet for projects, and link to setuptools documentation
instead.

0 comments on commit 491846b

Please sign in to comment.