docs: expand running Python scripts examples - #11002
Open
Whning0513 wants to merge 2 commits into
Open
Conversation
There was a problem hiding this comment.
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) usingtool.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.Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Fixes #9012.
Expand the
poetry rundocumentation with a small project layout, a script example, and command-line argument handling.