Skip to content

Conversation

CortexShadow
Copy link

Summary
Improves the documentation for pip freeze --all by adding a clear explanatory note and a before/after example. This is a documentation-only change; no behavior is modified.

Motivation
The current description of --all can be misread and leaves ambiguity about which packages are shown. By making it explicit that pip, setuptools, and wheel are skipped by default—and included with --all—the docs now provide a more accurate and practical mental model for users.

Changes

  • Added a .. note:: clarifying default behavior and the effect of --all.
  • Introduced Unix and Windows examples comparing pip freeze vs. pip freeze --all.
  • Kept the style consistent with the CLI reference page.

Notes

  • Local linters, pre-commit hooks, targeted freeze tests, and the Sphinx docs build all pass.
  • No changelog/news entry is required since this is docs-only.

Related
Closes #13557

@notatallshaw
Copy link
Member

Hi @CoretexShadow thanks for submitting this PR to pip!

All pip maintainers currently operate on a volunteer basis, so it can take some time for one of to take a look and review a PR. I will try and make some time soon to review this PR though.

@sepehr-rs
Copy link
Contributor

Hi @CortexShadow, thanks a lot for contributing to pip!
I’m not on the triage team yet, so I can’t formally approve, but I checked the updated docs and they’re consistent with pip’s behavior. This looks good to me!

@CortexShadow
Copy link
Author

Hi @CortexShadow, thanks a lot for contributing to pip! I’m not on the triage team yet, so I can’t formally approve, but I checked the updated docs and they’re consistent with pip’s behavior. This looks good to me!

Thanks for checking this and confirming! Really appreciate your feedback.

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

Successfully merging this pull request may close these issues.

Clarify pip freeze --all documentation at pip.pypa.io
3 participants