Skip to content

Fix cache clear example to use PyPI instead of pypi#10749

Merged
Secrus merged 1 commit intopython-poetry:mainfrom
thakoreh:fix-cache-clear-docs
Feb 25, 2026
Merged

Fix cache clear example to use PyPI instead of pypi#10749
Secrus merged 1 commit intopython-poetry:mainfrom
thakoreh:fix-cache-clear-docs

Conversation

@thakoreh
Copy link
Contributor

@thakoreh thakoreh commented Feb 24, 2026

Fixes #10743

Problem

The package-specific cache clear example uses lowercase pypi while the --all example above it uses PyPI. Since cache names are case-sensitive, this inconsistency can cause issues when users copy/paste the example.

Solution

Updated the example from poetry cache clear pypi:requests:2.24.0 to poetry cache clear PyPI:requests:2.24.0 to be consistent with the --all example.

References

Summary by Sourcery

Documentation:

  • Correct the package-specific cache clear example to use the proper case-sensitive PyPI cache name.

The cache name is case-sensitive. Updated the package-specific example
to be consistent with the --all example above it which uses PyPI.

Fixes: python-poetry#10743
@sourcery-ai
Copy link

sourcery-ai bot commented Feb 24, 2026

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


Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on 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 issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on 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 dismiss on 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 review to 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

Copy link

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

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

Hey - I've reviewed your changes and they look great!


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.

@Secrus Secrus merged commit d4e9399 into python-poetry:main Feb 25, 2026
54 checks passed
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.

Docs: cache clear page still shows lowercase pypi in package specific example after #9736 fix

2 participants