Uh oh!
There was an error while loading. Please reload this page.
- Notifications
You must be signed in to change notification settings - Fork 33.9k
gh-101100: Fix sphinx warnings in library/site.rst#110144
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Uh oh!
There was an error while loading. Please reload this page.
Merged
Changes from all commits
Commits
Show all changes
3 commits Select commit Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Uh oh!
There was an error while loading. Please reload this page.
Jump to
Jump to file
Failed to load files.
Loading
Uh oh!
There was an error while loading. Please reload this page.
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -19,7 +19,7 @@ Importing this module will append site-specific paths to the module search path | ||
| and add a few builtins, unless :option:`-S` was used. In that case, this module | ||
| can be safely imported with no automatic modifications to the module search path | ||
| or additions to the builtins. To explicitly trigger the usual site-specific | ||
| additions, call the :func:`site.main` function. | ||
| additions, call the :func:`main` function. | ||
| .. versionchanged:: 3.3 | ||
| Importing the module used to trigger paths manipulation even when using | ||
| @@ -109,32 +109,40 @@ directory precedes the :file:`foo` directory because :file:`bar.pth` comes | ||
| alphabetically before :file:`foo.pth`; and :file:`spam` is omitted because it is | ||
| not mentioned in either path configuration file. | ||
| .. index:: pair: module; sitecustomize | ||
| :mod:`sitecustomize` | ||
| -------------------- | ||
| .. module:: sitecustomize | ||
| After these path manipulations, an attempt is made to import a module named | ||
| :mod:`sitecustomize`, which can perform arbitrary site-specific customizations. | ||
| It is typically created by a system administrator in the site-packages | ||
| directory. If this import fails with an :exc:`ImportError` or its subclass | ||
| exception, and the exception's :attr:`name` attribute equals to ``'sitecustomize'``, | ||
| exception, and the exception's :attr:`~ImportError.name` | ||
| attribute equals to ``'sitecustomize'``, | ||
| it is silently ignored. If Python is started without output streams available, as | ||
| with :file:`pythonw.exe` on Windows (which is used by default to start IDLE), | ||
| attempted output from :mod:`sitecustomize` is ignored. Any other exception | ||
| causes a silent and perhaps mysterious failure of the process. | ||
| .. index:: pair: module; usercustomize | ||
| :mod:`usercustomize` | ||
| -------------------- | ||
| .. module:: usercustomize | ||
sobolevn marked this conversation as resolved. Show resolvedHide resolvedUh oh!There was an error while loading. Please reload this page. | ||
| After this, an attempt is made to import a module named :mod:`usercustomize`, | ||
| which can perform arbitrary user-specific customizations, if | ||
| :data:`ENABLE_USER_SITE` is true. This file is intended to be created in the | ||
| :data:`~site.ENABLE_USER_SITE` is true. This file is intended to be created in the | ||
| user site-packages directory (see below), which is part of ``sys.path`` unless | ||
| disabled by :option:`-s`. If this import fails with an :exc:`ImportError` or | ||
| its subclass exception, and the exception's :attr:`name` attribute equals to | ||
| ``'usercustomize'``, it is silently ignored. | ||
| its subclass exception, and the exception's :attr:`~ImportError.name` | ||
| attribute equals to ``'usercustomize'``, it is silently ignored. | ||
| Note that for some non-Unix systems, ``sys.prefix`` and ``sys.exec_prefix`` are | ||
| empty, and the path manipulations are skipped; however the import of | ||
| :mod:`sitecustomize` and :mod:`usercustomize` is still attempted. | ||
| .. currentmodule:: site | ||
| .. _rlcompleter-config: | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
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.
Uh oh!
There was an error while loading. Please reload this page.