summaryrefslogtreecommitdiffstats
path: root/Doc/library
diff options
context:
space:
mode:
authorSerhiy Storchaka <storchaka@gmail.com>2023-07-23 09:24:51 (GMT)
committerGitHub <noreply@github.com>2023-07-23 09:24:51 (GMT)
commit456cf8b0972bedf035c648fcd5e384ead937f9db (patch)
tree1dae1246fd1d94b1b20f2d24d3bddb8a5c7d0282 /Doc/library
parent98626c3c71f88707d7297d18e01801f27192ab5c (diff)
downloadcpython-456cf8b0972bedf035c648fcd5e384ead937f9db.zip
cpython-456cf8b0972bedf035c648fcd5e384ead937f9db.tar.gz
cpython-456cf8b0972bedf035c648fcd5e384ead937f9db.tar.bz2
[3.12] gh-106948: Add standard external names to nitpick_ignore (GH-106949) (#107060)
* [3.12] gh-106948: Add standard external names to nitpick_ignore (GH-106949) It includes standard C types, macros and variables like "size_t", "LONG_MAX" and "errno", and standard environment variables like "PATH". (cherry picked from commit f8b7fe2f2647813ae8249675a80e59c117d30fe1) Co-authored-by: Serhiy Storchaka <storchaka@gmail.com> * Delete 2023-05-31-18-37-57.gh-issue-105156.R4El5V.rst
Diffstat (limited to 'Doc/library')
-rw-r--r--Doc/library/array.rst4
-rw-r--r--Doc/library/ctypes.rst12
-rw-r--r--Doc/library/os.rst2
-rw-r--r--Doc/library/struct.rst4
-rw-r--r--Doc/library/venv.rst6
5 files changed, 14 insertions, 14 deletions
diff --git a/Doc/library/array.rst b/Doc/library/array.rst
index 75c49e0..d6cb8c6 100644
--- a/Doc/library/array.rst
+++ b/Doc/library/array.rst
@@ -51,9 +51,9 @@ Notes:
It can be 16 bits or 32 bits depending on the platform.
.. versionchanged:: 3.9
- ``array('u')`` now uses ``wchar_t`` as C type instead of deprecated
+ ``array('u')`` now uses :c:type:`wchar_t` as C type instead of deprecated
``Py_UNICODE``. This change doesn't affect its behavior because
- ``Py_UNICODE`` is alias of ``wchar_t`` since Python 3.3.
+ ``Py_UNICODE`` is alias of :c:type:`wchar_t` since Python 3.3.
.. deprecated-removed:: 3.3 4.0
diff --git a/Doc/library/ctypes.rst b/Doc/library/ctypes.rst
index 81509c0..c253a45 100644
--- a/Doc/library/ctypes.rst
+++ b/Doc/library/ctypes.rst
@@ -220,7 +220,7 @@ Fundamental data types
+----------------------+------------------------------------------+----------------------------+
| :class:`c_char` | :c:expr:`char` | 1-character bytes object |
+----------------------+------------------------------------------+----------------------------+
-| :class:`c_wchar` | :c:expr:`wchar_t` | 1-character string |
+| :class:`c_wchar` | :c:type:`wchar_t` | 1-character string |
+----------------------+------------------------------------------+----------------------------+
| :class:`c_byte` | :c:expr:`char` | int |
+----------------------+------------------------------------------+----------------------------+
@@ -243,9 +243,9 @@ Fundamental data types
| :class:`c_ulonglong` | :c:expr:`unsigned __int64` or | int |
| | :c:expr:`unsigned long long` | |
+----------------------+------------------------------------------+----------------------------+
-| :class:`c_size_t` | :c:expr:`size_t` | int |
+| :class:`c_size_t` | :c:type:`size_t` | int |
+----------------------+------------------------------------------+----------------------------+
-| :class:`c_ssize_t` | :c:expr:`ssize_t` or | int |
+| :class:`c_ssize_t` | :c:type:`ssize_t` or | int |
| | :c:expr:`Py_ssize_t` | |
+----------------------+------------------------------------------+----------------------------+
| :class:`c_time_t` | :c:type:`time_t` | int |
@@ -335,7 +335,7 @@ property::
The :func:`create_string_buffer` function replaces the old :func:`c_buffer`
function (which is still available as an alias). To create a mutable memory
-block containing unicode characters of the C type :c:expr:`wchar_t`, use the
+block containing unicode characters of the C type :c:type:`wchar_t`, use the
:func:`create_unicode_buffer` function.
@@ -478,7 +478,7 @@ By default functions are assumed to return the C :c:expr:`int` type. Other
return types can be specified by setting the :attr:`restype` attribute of the
function object.
-The C prototype of ``time()`` is ``time_t time(time_t *)``. Because ``time_t``
+The C prototype of ``time()`` is ``time_t time(time_t *)``. Because :c:type:`time_t`
might be of a different type than the default return type ``int``, you should
specify the ``restype``::
@@ -2407,7 +2407,7 @@ These are the fundamental ctypes data types:
.. class:: c_wchar
- Represents the C :c:expr:`wchar_t` datatype, and interprets the value as a
+ Represents the C :c:type:`wchar_t` datatype, and interprets the value as a
single character unicode string. The constructor accepts an optional string
initializer, the length of the string must be exactly one character.
diff --git a/Doc/library/os.rst b/Doc/library/os.rst
index 127d161..5740591 100644
--- a/Doc/library/os.rst
+++ b/Doc/library/os.rst
@@ -4650,7 +4650,7 @@ written in Python, such as a mail server's external command delivery program.
:data:`WNOHANG` and :data:`WNOWAIT` are additional optional flags.
The return value is an object representing the data contained in the
- :c:type:`!siginfo_t` structure with the following attributes:
+ :c:type:`siginfo_t` structure with the following attributes:
* :attr:`!si_pid` (process ID)
* :attr:`!si_uid` (real user ID of the child)
diff --git a/Doc/library/struct.rst b/Doc/library/struct.rst
index 6d2739b..c94dfde 100644
--- a/Doc/library/struct.rst
+++ b/Doc/library/struct.rst
@@ -231,9 +231,9 @@ platform-dependent.
| ``Q`` | :c:expr:`unsigned long | integer | 8 | \(2) |
| | long` | | | |
+--------+--------------------------+--------------------+----------------+------------+
-| ``n`` | :c:expr:`ssize_t` | integer | | \(3) |
+| ``n`` | :c:type:`ssize_t` | integer | | \(3) |
+--------+--------------------------+--------------------+----------------+------------+
-| ``N`` | :c:expr:`size_t` | integer | | \(3) |
+| ``N`` | :c:type:`size_t` | integer | | \(3) |
+--------+--------------------------+--------------------+----------------+------------+
| ``e`` | \(6) | float | 2 | \(4) |
+--------+--------------------------+--------------------+----------------+------------+
diff --git a/Doc/library/venv.rst b/Doc/library/venv.rst
index 9e56725..2482441 100644
--- a/Doc/library/venv.rst
+++ b/Doc/library/venv.rst
@@ -60,7 +60,7 @@ running from a virtual environment.
A virtual environment may be "activated" using a script in its binary directory
(``bin`` on POSIX; ``Scripts`` on Windows).
-This will prepend that directory to your :envvar:`!PATH`, so that running
+This will prepend that directory to your :envvar:`PATH`, so that running
:program:`python` will invoke the environment's Python interpreter
and you can run installed scripts without having to use their full path.
The invocation of the activation script is platform-specific
@@ -100,10 +100,10 @@ In order to achieve this, scripts installed into virtual environments have
a "shebang" line which points to the environment's Python interpreter,
i.e. :samp:`#!/{<path-to-venv>}/bin/python`.
This means that the script will run with that interpreter regardless of the
-value of :envvar:`!PATH`. On Windows, "shebang" line processing is supported if
+value of :envvar:`PATH`. On Windows, "shebang" line processing is supported if
you have the :ref:`launcher` installed. Thus, double-clicking an installed
script in a Windows Explorer window should run it with the correct interpreter
-without the environment needing to be activated or on the :envvar:`!PATH`.
+without the environment needing to be activated or on the :envvar:`PATH`.
When a virtual environment has been activated, the :envvar:`!VIRTUAL_ENV`
environment variable is set to the path of the environment.