mirrors/cpython
1
0
Fork 0
mirror of https://github.com/python/cpython.git synced 2025-08-04 00:48:58 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 8

gh-93738: Documentation C syntax (Use c:struct) (#97772)

Browse source 
Use `c:struct`
This commit is contained in:
Adam Turner 2022-10-05 00:26:14 +01:00 • committed by GitHub
parent fa59bda8d3
commit a0f5599aac
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
6 changed files with 15 additions and 15 deletions
Download patch file Download diff file Expand all files Collapse all files

4
Doc/library/ctypes.rst
View file

@ -1088,7 +1088,7 @@ An extended example which also demonstrates the use of pointers accesses the
Quoting the docs for that value:
This pointer is initialized to point to an array of :c:type:`struct _frozen`
This pointer is initialized to point to an array of :c:struct:`_frozen`
records, terminated by one whose members are all ``NULL`` or zero. When a frozen
module is imported, it is searched in this table. Third-party code could play
tricks with this to provide a dynamically created collection of frozen modules.
@ -1107,7 +1107,7 @@ size, we show only how this table can be read with :mod:`ctypes`::
...
>>>
We have defined the :c:type:`struct _frozen` data type, so we can get the pointer
We have defined the :c:struct:`_frozen` data type, so we can get the pointer
to the table::
>>> FrozenTable = POINTER(struct_frozen)

12
Doc/library/socket.rst
View file

@ -1059,7 +1059,7 @@ The :mod:`socket` module also offers various network-related services:
Convert an IPv4 address from dotted-quad string format (for example,
'123.45.67.89') to 32-bit packed binary format, as a bytes object four characters in
length. This is useful when conversing with a program that uses the standard C
library and needs objects of type :c:type:`struct in_addr`, which is the C type
library and needs objects of type :c:struct:`in_addr`, which is the C type
for the 32-bit packed binary this function returns.
:func:`inet_aton` also accepts strings with less than three dots; see the
@ -1078,7 +1078,7 @@ The :mod:`socket` module also offers various network-related services:
Convert a 32-bit packed IPv4 address (a :term:`bytes-like object` four
bytes in length) to its standard dotted-quad string representation (for example,
'123.45.67.89'). This is useful when conversing with a program that uses the
standard C library and needs objects of type :c:type:`struct in_addr`, which
standard C library and needs objects of type :c:struct:`in_addr`, which
is the C type for the 32-bit packed binary data this function takes as an
argument.
@ -1095,8 +1095,8 @@ The :mod:`socket` module also offers various network-related services:
Convert an IP address from its family-specific string format to a packed,
binary format. :func:`inet_pton` is useful when a library or network protocol
calls for an object of type :c:type:`struct in_addr` (similar to
:func:`inet_aton`) or :c:type:`struct in6_addr`.
calls for an object of type :c:struct:`in_addr` (similar to
:func:`inet_aton`) or :c:struct:`in6_addr`.
Supported values for *address_family* are currently :const:`AF_INET` and
:const:`AF_INET6`. If the IP address string *ip_string* is invalid,
@ -1116,8 +1116,8 @@ The :mod:`socket` module also offers various network-related services:
bytes) to its standard, family-specific string representation (for
example, ``'7.10.0.5'`` or ``'5aef:2b::8'``).
:func:`inet_ntop` is useful when a library or network protocol returns an
object of type :c:type:`struct in_addr` (similar to :func:`inet_ntoa`) or
:c:type:`struct in6_addr`.
object of type :c:struct:`in_addr` (similar to :func:`inet_ntoa`) or
:c:struct:`in6_addr`.
Supported values for *address_family* are currently :const:`AF_INET` and
:const:`AF_INET6`. If the bytes object *packed_ip* is not the correct