Skip to content

Commit 70802ff

Browse files
committed
Added notice about type file + Review comments
1 parent d0564f6 commit 70802ff

File tree

1 file changed

+3
-2
lines changed

1 file changed

+3
-2
lines changed

docs/pyproject.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -723,6 +723,7 @@ for more information on other keys and specifying version ranges.
723723
### scripts
724724

725725
**Deprecated**: Use `project.scripts` instead.
726+
Use `[tool.poetry.scripts]` only for scripts of type "file", because those are not supported in `[project.scripts]`.
726727

727728
This section describes the scripts or executables that will be installed when installing the package
728729

@@ -742,12 +743,12 @@ When a script is added or updated, run `poetry install` to make them available i
742743
my_executable = { reference = "some_binary.exe", type = "file" }
743744
```
744745

745-
With this configuration, Poetry will look for the referenced file in the active project and then copy it to the OS installation directory.
746+
This tells Poetry to include the specified file, relative to your project directory, in distribution builds. It will then be copied to the appropriate installation directory for your operating system when your package is installed.
746747

747748
* On Windows the file is placed in the `Scripts/` directory.
748749
* On *nix system the file is placed in the `bin/` directory.
749750

750-
## `extras`
751+
### `extras`
751752

752753
**Deprecated**: Use `project.optional-dependencies` instead.
753754

0 commit comments

Comments
 (0)