docs(pip_freeze): clarify --all; add concise example #13563
+53
−0
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.
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 thatpip
,setuptools
, andwheel
are skipped by default—and included with--all
—the docs now provide a more accurate and practical mental model for users.Changes
.. note::
clarifying default behavior and the effect of--all
.pip freeze
vs.pip freeze --all
.Notes
Related
Closes #13557