Skip to content

docs: expand running Python scripts examples - #11002

Open
Whning0513 wants to merge 2 commits into
python-poetry:mainfrom
Whning0513:docs/9012-running-scripts
Open

docs: expand running Python scripts examples#11002
Whning0513 wants to merge 2 commits into
python-poetry:mainfrom
Whning0513:docs/9012-running-scripts

Conversation

@Whning0513

Copy link
Copy Markdown

Fixes #9012.

Expand the poetry run documentation with a small project layout, a script example, and command-line argument handling.

Copilot AI review requested due to automatic review settings July 31, 2026 09:45

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copilot was unable to review this pull request because the user who requested the review has reached their quota limit.

@sourcery-ai sourcery-ai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey - I've left some high level feedback:

  • In the first shell example, consider removing the trailing blank line inside the fenced code block to keep formatting consistent with other command snippets in the docs.
  • Since this section now shows running scripts directly with python, it may be helpful to briefly mention (or link to) using tool.poetry.scripts/entry points for more typical CLI usage to clarify when each approach is recommended.
Prompt for AI Agents
Please address the comments from this code review:

## Overall Comments
- In the first shell example, consider removing the trailing blank line inside the fenced code block to keep formatting consistent with other command snippets in the docs.
- Since this section now shows running scripts directly with `python`, it may be helpful to briefly mention (or link to) using `tool.poetry.scripts`/entry points for more typical CLI usage to clarify when each approach is recommended.

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Improvement of Documentation for Running Scripts with Poetry

2 participants