Skip to content
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鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

[3.12] gh-101100: Fix sphinx warnings in usage/cmdline.rst (GH-110841) #110855

Merged
merged 1 commit into from
Oct 14, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
1 change: 0 additions & 1 deletion Doc/tools/.nitignore
Original file line number Diff line number Diff line change
Expand Up @@ -162,7 +162,6 @@ Doc/reference/import.rst
Doc/reference/simple_stmts.rst
Doc/tutorial/datastructures.rst
Doc/tutorial/introduction.rst
Doc/using/cmdline.rst
Doc/using/windows.rst
Doc/whatsnew/2.0.rst
Doc/whatsnew/2.1.rst
Expand Down
17 changes: 9 additions & 8 deletions Doc/using/cmdline.rst
Original file line number Diff line number Diff line change
Expand Up @@ -103,7 +103,7 @@ source.

:option:`-I` option can be used to run the script in isolated mode where
:data:`sys.path` contains neither the current directory nor the user's
site-packages directory. All :envvar:`PYTHON*` environment variables are
site-packages directory. All ``PYTHON*`` environment variables are
ignored, too.

Many standard library modules contain code that is invoked on their execution
Expand Down Expand Up @@ -161,7 +161,7 @@ source.

:option:`-I` option can be used to run the script in isolated mode where
:data:`sys.path` contains neither the script's directory nor the user's
site-packages directory. All :envvar:`PYTHON*` environment variables are
site-packages directory. All ``PYTHON*`` environment variables are
ignored, too.

.. audit-event:: cpython.run_file filename
Expand Down Expand Up @@ -280,7 +280,7 @@ Miscellaneous options

.. option:: -E

Ignore all :envvar:`PYTHON*` environment variables, e.g.
Ignore all ``PYTHON*`` environment variables, e.g.
:envvar:`PYTHONPATH` and :envvar:`PYTHONHOME`, that might be set.

See also the :option:`-P` and :option:`-I` (isolated) options.
Expand All @@ -303,7 +303,7 @@ Miscellaneous options
and :option:`-s` options.

In isolated mode :data:`sys.path` contains neither the script's directory nor
the user's site-packages directory. All :envvar:`PYTHON*` environment
the user's site-packages directory. All ``PYTHON*`` environment
variables are ignored, too. Further restrictions may be imposed to prevent
the user from injecting malicious code.

Expand Down Expand Up @@ -362,7 +362,7 @@ Miscellaneous options
randomization is enabled by default.

On previous versions of Python, this option turns on hash randomization,
so that the :meth:`__hash__` values of str and bytes objects
so that the :meth:`~object.__hash__` values of str and bytes objects
are "salted" with an unpredictable random value. Although they remain
constant within an individual Python process, they are not predictable
between repeated invocations of Python.
Expand Down Expand Up @@ -851,9 +851,10 @@ conflict.

If this environment variable is set to a non-empty string,
:func:`faulthandler.enable` is called at startup: install a handler for
:const:`SIGSEGV`, :const:`SIGFPE`, :const:`SIGABRT`, :const:`SIGBUS` and
:const:`SIGILL` signals to dump the Python traceback. This is equivalent to
:option:`-X` ``faulthandler`` option.
:const:`~signal.SIGSEGV`, :const:`~signal.SIGFPE`,
:const:`~signal.SIGABRT`, :const:`~signal.SIGBUS` and
:const:`~signal.SIGILL` signals to dump the Python traceback.
This is equivalent to :option:`-X` ``faulthandler`` option.

.. versionadded:: 3.3

Expand Down