Fix cache clear example to use PyPI instead of pypi by thakoreh · Pull Request #10749 · python-poetry/poetry (original) (raw)
Reviewer's guide (collapsed on small PRs)
Reviewer's Guide
Updates the CLI documentation example for clearing a specific cache entry to use the correct, case-sensitive cache name PyPI instead of pypi, aligning it with the earlier --all example and preventing copy/paste errors.
File-Level Changes
| Change | Details | Files |
|---|---|---|
| Correct case-sensitive cache name in cache clear CLI example to match actual behavior and prior example. | Update the package-specific cache clear example to use PyPI instead of pypi in the cache specifier.Ensure consistency between the --all cache clear example and the single-package cache clear example in the docs. | docs/cli.md |
Assessment against linked issues
| Issue | Objective | Addressed | Explanation |
|---|---|---|---|
| #10743 | Update the package-specific poetry cache clear documentation example to use the correctly capitalized PyPI cache name (matching the --all example and case-sensitive behavior). | ✅ | |
| #10743 | Add documentation guidance advising users to run poetry cache list and use the exact cache name shown on their system when clearing cache entries. | ❌ | The PR only updates the example command from poetry cache clear pypi:requests:2.24.0 to poetry cache clear PyPI:requests:2.24.0 and does not add any note or guidance about using poetry cache list or matching the cache name shown on the system. |
Possibly linked issues
- Docs: cache clear page still shows lowercase pypi in package specific example after #9736 fix #10743: PR updates the cache clear example from lowercase pypi to PyPI, exactly fixing the documented inconsistency.
Tips and commands
Interacting with Sourcery
- Trigger a new review: Comment
@sourcery-ai reviewon the pull request. - Continue discussions: Reply directly to Sourcery's review comments.
- Generate a GitHub issue from a review comment: Ask Sourcery to create an
issue from a review comment by replying to it. You can also reply to a
review comment with@sourcery-ai issueto create an issue from it. - Generate a pull request title: Write
@sourcery-aianywhere in the pull
request title to generate a title at any time. You can also comment@sourcery-ai titleon the pull request to (re-)generate the title at any time. - Generate a pull request summary: Write
@sourcery-ai summaryanywhere in
the pull request body to generate a PR summary at any time exactly where you
want it. You can also comment@sourcery-ai summaryon the pull request to
(re-)generate the summary at any time. - Generate reviewer's guide: Comment
@sourcery-ai guideon the pull
request to (re-)generate the reviewer's guide at any time. - Resolve all Sourcery comments: Comment
@sourcery-ai resolveon the
pull request to resolve all Sourcery comments. Useful if you've already
addressed all the comments and don't want to see them anymore. - Dismiss all Sourcery reviews: Comment
@sourcery-ai dismisson the pull
request to dismiss all existing Sourcery reviews. Especially useful if you
want to start fresh with a new review - don't forget to comment@sourcery-ai reviewto trigger a new review!
Customizing Your Experience
Access your dashboard to:
- Enable or disable review features such as the Sourcery-generated pull request
summary, the reviewer's guide, and others. - Change the review language.
- Add, remove or edit custom review instructions.
- Adjust other review settings.
Getting Help
- Contact our support team for questions or feedback.
- Visit our documentation for detailed guides and information.
- Keep in touch with the Sourcery team by following us on X/Twitter, LinkedIn or GitHub.