docs: Improve --user/--no-user documentation#13782
docs: Improve --user/--no-user documentation#13782Ashutosh0x wants to merge 3 commits intopypa:mainfrom
Conversation
30dae2b to
e676f15
Compare
There was a problem hiding this comment.
Why did this change? Seems like noise.
There was a problem hiding this comment.
Same here, why did this change?
news/12924.doc.rst
Outdated
There was a problem hiding this comment.
This news item is way too long, news items appear as bullet points in the change log. As a rule of thumb keep all news items to a short one or two sentences. For example this could just be:
Improved documentation for the ``--user`` and ``--no-user`` options.
|
I don't think we can document or this feature without making them mutually exclusive, and I don't think we can do that without warning users first, we could need to trigger a deprecation warning for two cycles if |
Summary
This PR improves the documentation for the --user and --no-user install options as requested in #12924.
Changes
Documentation Updates (docs/html/user_guide.rst)
Added 'Automatic User Install Fallback' section: Documents the often-surprising behavior where pip automatically falls back to a user install when site-packages is not writeable.
Added '--no-user Option' section: Documents the previously hidden --no-user option and its use cases.
Added 'Environment Variables' section: Documents PIP_USER for controlling user install behavior, and PYTHONUSERBASE for customizing install location.
Source Code Changes (src/pip/_internal/commands/install.py)
News Fragment
Added
ews/12924.doc.rst documenting the changes.
Fixes
Closes #12924
Testing