docs: add admonition about tool.pdm.scripts vs project.scripts (#2673)

pdm-project · Mar 7, 2024 · a12d0bc · a12d0bc
1 parent 1bf5eb1
commit a12d0bc
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 0 deletions.
diff --git a/docs/docs/usage/scripts.md b/docs/docs/usage/scripts.md
@@ -14,6 +14,9 @@ It will run `flask run -p 54321` in the environment that is aware of packages in
 
 PDM also supports custom script shortcuts in the optional `[tool.pdm.scripts]` section of `pyproject.toml`.
 
+!!! NOTE
+  The `[tool.pdm.scripts]` directory must not be confused with `[project.scripts]`. The latter is used to install a command as part of your package, as explained [here](https://packaging.python.org/en/latest/guides/writing-pyproject-toml/#creating-executable-scripts).
+
 You can then run `pdm run <script_name>` to invoke the script in the context of your PDM project. For example:
 
 ```toml

diff --git a/news/2121.docs.md b/news/2121.docs.md
@@ -0,0 +1 @@
+Document the difference between `[tool.pdm.scripts]` and `[project.scripts]`
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1 @@
		Document the difference between `[tool.pdm.scripts]` and `[project.scripts]`