docs: clarify poetry run and console scripts usage#10984
Open
xu430 wants to merge 2 commits into
Open
Conversation
Add a concrete package layout, CLI argument examples, and common failure modes for console scripts so newcomers can wire up and run entry points. Fixes python-poetry#9012 Co-authored-by: Xu Mingxuan <207414859+xu430@users.noreply.github.com>
![sourcery-ai[bot]](https://avatars.githubusercontent.com/in/48477?s=60&v=4){kind=small}
There was a problem hiding this comment.
Hey - I've left some high level feedback:
- The notes about re-running
poetry installafter changing scripts now appear in bothcli.mdandpyproject.md; consider consolidating or cross-referencing them to avoid duplication and keep the guidance in one canonical place. - You introduce both the term “console scripts” and the entry-point explanation; it may help to explicitly tie those together (e.g. “console scripts (Python entry points)”) in both files for consistent terminology and easier cross-navigation.
Prompt for AI Agents
Please address the comments from this code review:
## Overall Comments
- The notes about re-running `poetry install` after changing scripts now appear in both `cli.md` and `pyproject.md`; consider consolidating or cross-referencing them to avoid duplication and keep the guidance in one canonical place.
- You introduce both the term “console scripts” and the entry-point explanation; it may help to explicitly tie those together (e.g. “console scripts (Python entry points)”) in both files for consistent terminology and easier cross-navigation.Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.
Use consistent “console scripts (entry points)” terminology and keep the poetry install refresh note canonical in pyproject, with a cross-link from the poetry run docs. Co-authored-by: Xu Mingxuan <207414859+xu430@users.noreply.github.com>
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
1 participant
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.
Pull Request Check List
Resolves: #9012