Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Clarifying scripts section in docs #5884

Merged
merged 2 commits into from
Jun 21, 2022
Merged

Clarifying scripts section in docs #5884

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
54aafb1
Clarifying `scripts` section in docs
Secrus Jun 20, 2022
92cf81c
Update docs/pyproject.md
Secrus Jun 21, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions docs/pyproject.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -336,10 +336,10 @@ This section describes the scripts or executables that will be installed when in

```toml
[tool.poetry.scripts]
poetry = 'poetry.console:run'
my_package_cli = 'my_package.console:run'
```

Here, we will have the `poetry` script installed which will execute `console.run` in the `poetry` package.
Here, we will have the `my_package_cli` script installed which will execute `run` function in the `console` module in the `my_package` package.
Secrus marked this conversation as resolved.
Show resolved Hide resolved

To specify a script that [depends on an extra](#extras), you may provide an entry as an inline table:

Expand Down