5a0d51b629
[3.11] gh-112020: Document the meaning of empty bytes returned by socket.recv() (GH-112055) (GH-115723)
...
(cherry picked from commit e71468ba4f
2024-02-20 15:00:30 +00:00
51858aa606
[3.11] gh-101100: Fix Sphinx warning in references with asterisks (GH-113029) ( #113044 )
2023-12-13 11:02:20 +02:00
03b522d3ef
[3.11] Backport PR #112477 : correct socket AF_PACKET docs ( #112478 )
...
Backport PR #112477 : correct socket AF_PACKET docs
Network byte order is not involved in the `int` on the Python side.
That happens under the hood.
Correctly use the term addresses instead of packets.
2023-11-27 23:54:21 +00:00
62e430af9e
[3.11] GH-101100: Fix reference warnings for ``socket`` methods (GH-110114) ( #112456 )
...
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
2023-11-27 17:03:45 +02:00
a10fc6670b
[3.11] gh-101100: Fix sphinx warnings in `library/asyncio-eventloop.rst` (GH-111222) ( #111470 )
...
gh-101100: Fix sphinx warnings in `library/asyncio-eventloop.rst` (GH-111222)
* gh-101100: Fix sphinx warnings in `library/asyncio-eventloop.rst`
* Update Doc/library/socket.rst
* Update asyncio-eventloop.rst
* Update socket.rst
---------
(cherry picked from commit 46389c3275
2023-10-29 19:39:25 +00:00
bf41dcda70
[3.11] gh-101100: Fix Sphinx warnings for `fileno` (GH-111118) ( #111227 )
...
Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
2023-10-23 19:18:00 +00:00
07471cda29
[3.11] gh-110631: Fix reST indentation in `Doc/library` (GH-110685) ( #110737 )
...
* [3.11] gh-110631: Fix reST indentation in `Doc/library` (GH-110685)
Fix wrong indentation in the Doc/library dir..
(cherry picked from commit bb7923f556
2023-10-11 23:11:41 +02:00
a55c203104
[3.11] gh-110383: Swap 'the all' -> 'all the' in socket docs (GH-110434) ( #110436 )
...
Co-authored-by: Bradley Reynolds <bradley.reynolds@darbia.dev>
2023-10-05 14:14:32 -06:00
cccb81d294
[3.11] socket documentation fix - rename triple to 3-tuple (GH-24722) ( #109074 )
...
Co-authored-by: Ori Hoch <ori@uumpa.com>
Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
2023-09-07 13:44:35 +03:00
b338ac7540
[3.11] gh-106909: Use role :const: for referencing module constants (GH-106910) (GH-106957)
...
(cherry picked from commit 4b9948617f
2023-07-21 14:49:57 +03:00
86eab0807f
[3.11] gh-104882: Docs: fix description of relationship between `socket.getblocking()` and `socket.gettimeout()` (GH-105026) ( #105284 )
...
gh-104882: Docs: fix description of relationship between `socket.getblocking()` and `socket.gettimeout()` (GH-105026)
(cherry picked from commit 5a5ed7a3e6
2023-06-04 17:09:13 +01:00
c463796ba7
[3.11] GH-97950: Use new-style index directive ('object') (GH-104158) ( #104159 )
...
GH-97950: Use new-style index directive ('object') (GH-104158)
* Uncomment object removal in pairindextypes
* Use new-style index directive ('object') - C API
* Use new-style index directive ('object') - Library
* Use new-style index directive ('object') - Reference
* Use new-style index directive ('object') - Tutorial
(cherry picked from commit 6ab463684b
2023-05-04 13:14:16 +03:00
00563694bb
[3.11] GH-97950: Use new-style index directive ('module') (GH-103996) ( #104154 )
2023-05-04 11:39:15 +03:00
6258c3cd53
Improve some grammar in the socket docs (GH-103254)
...
(cherry picked from commit bceb9e00ad
2023-04-04 15:54:37 -07:00
c7dcfdaef6
gh-96773 Fix documentation of socket backlog (GH-96778)
...
(cherry picked from commit 1d1480fefc
2023-01-01 07:13:50 -08:00
ea19c28512
[3.11] Docs: Fix backtick errors found by sphinx-lint (GH-97998) ( #98371 )
...
Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com>.
(cherry picked from commit fa2d43e518
2022-10-18 01:49:38 +02:00
83ad76275c
[3.11] gh-93738: Documentation C syntax (:c:type:<C type> -> :c:expr:<C type>) (GH-97768) ( #97924 )
...
:c:type:`<C type>` -> :c:expr:`<C type>`
Co-authored-by: Łukasz Langa <lukasz@langa.pl>
(cherry picked from commit 0031e62973
2022-10-05 14:11:12 -07:00
d5852a090f
[3.11] gh-93738: Documentation C syntax (Use `c:struct`) (GH-97772) ( #97869 )
...
Use `c:struct`
(cherry picked from commit a0f5599aac
2022-10-05 08:20:03 -07:00
d8df7e0207
[3.11] gh-91838: Use HTTPS links in docs for resources which redirect to HTTPS (GH-95527) (GH-95643)
...
If an HTTP link is redirected to a same looking HTTPS link, the latter can
be used directly without changes in readability and behavior.
It protects from a men-in-the-middle attack.
This change does not affect Python examples..
(cherry picked from commit f79547a429
2022-08-04 11:45:03 +03:00
72cad6cfe5
gh-95451: Update docs for wasm32-emscripten and -wasi platforms (GH-95452)
...
Co-authored-by: Éric <merwok@netwok.org>
Co-authored-by: Michael Droettboom <mdboom@gmail.com>
Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com>
Co-authored-by: CAM Gerlach <CAM.Gerlach@Gerlach.CAM>
(cherry picked from commit e3b6ff19aa
2022-08-02 12:13:07 -07:00
9af9ea28e7
[3.11] gh-95415: Make availability directive consistent (GH-95416) (GH-95438)
...
Co-authored-by: Christian Heimes <christian@python.org>
2022-08-01 14:26:19 +02:00
77bf973930
Docs: remove redundant "adverb-adjective" hyphens from compound modifiers (GH-94551) (GH-94557)
...
Discussion: https://discuss.python.org/t/slight-grammar-fix-throughout-adverbs-dont-need-hyphen/17021
(cherry picked from commit 3440d197a5
2022-07-05 14:30:19 +02:00
cde0dadd34
gh-93183: Adjust wording in socket docs (GH-93832)
...
package => packet
Co-authored-by: Victor Norman
(cherry picked from commit cdd3984307
2022-06-15 01:44:14 -07:00
d779e5d16e
Remove the execution bit to some socket-related files. (GH-93368)
...
(cherry picked from commit 5247389369
2022-06-01 00:35:15 -07:00
a2d6e6c206
gh-92417: `socket` docs: remove references to Python <3.3 (GH-92544) (GH-92968)
...
(cherry picked from commit 639b62c9c4
2022-05-19 17:42:07 +02:00
d5dfcd4489
bpo-46696: Add socket.SO_INCOMING_CPU constant ( #31237 )
...
Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
2022-05-03 11:33:11 -06:00
ad9f817eeb
gh-91498: socket: Add TCP_CONNECTION_INFO on macOS ( #69256 )
...
Fixes GH-91498
2022-04-27 06:47:17 -06:00
3c43806513
gh-74166: make all_errors keyword-only (GH-91704)
2022-04-19 18:16:20 +01:00
39a54ba638
gh-74166: Add option to get all errors from socket.create_connection (GH-91586)
2022-04-18 23:15:41 +01:00
33698e8ff4
bpo-46030: socket module add couple of FreeBSD constants. (GH-30018)
...
Co-authored-by: Andrew Svetlov <andrew.svetlov@gmail.com>
2022-03-17 22:40:00 +02:00
40fcd16889
bpo-30512: Add CAN Socket support for NetBSD (GH-30066)
2022-01-21 09:44:05 +02:00
4c792f39e6
bpo-45772: socket.socket should be a class instead of a function (GH-23960)
...
* bpo-45772: socket.socket should be a class instead of a function
Currently `socket.socket` is documented as a function, but it is really
a class (and thus has function-like usage to construct an object). This
correction would ensure that Python projects that are interlinking
Python's documentation can properly locate `socket.socket` as a type.
2021-11-13 08:02:04 +02:00
51375388be
bpo-41983: add availability info to socket docs (GH-27519)
...
* add availability info to AF_PACKET section
* add availability for AF_QIPCRTR as well
2021-10-21 23:13:37 +02:00
4103280b83
[doc] Fix gethostbyname_ex description (GH-28700)
...
It seems part of `gethostbyname_ex` doc was copied from `gethostbyaddr`. The latter has an `ip_address` parameter whereas the former doesn't.
2021-10-05 18:53:35 +02:00
36122e1814
bpo-41203: Replace Mac OS X and OS X with macOS (GH-28515)
...
Replace old names when they refer to actual versions of macOS.
Keep historical names in references to older versions.
Co-authored-by: Patrick Reader <_@pxeger.com>
2021-09-22 20:33:36 +03:00
fdcb675eed
bpo-40635: Fix getfqdn() docstring and docs (GH-27971)
...
Co-authored-by: Łukasz Langa <lukasz@langa.pl>
2021-08-26 20:40:28 +02:00
11749e2dc2
bpo-44740: Lowercase "internet" and "web" where appropriate. ( #27378 )
...
Co-authored-by: Łukasz Langa <lukasz@langa.pl>
2021-07-27 00:11:55 +02:00
d59d7374a3
bpo-34932: Add socket.TCP_KEEPALIVE for macOS (GH-25079)
2021-07-14 23:53:15 +01:00
a317778fd5
bpo-44077: Expose IP_RECVTOS in the socket module (GH-25992)
...
Co-authored-by: Pablo Galindo <pablogsal@gmail.com>
2021-06-20 21:08:07 +01:00
5f28752f5b
bpo-43750: Fix incorrect reference to PACKET_MULTIHOST in the docs (GH-25241)
...
It should be PACKET_MULTICAST, not PACKET_MULTIHOST.
2021-05-29 19:46:01 -03:00
660592f67c
bpo-28724: Doc: Move socket.send_fds and socket.recv_fds docs to right section (GH-22608)
2021-04-22 13:08:46 +09:00
b775106d94
bpo-40066: Enum: modify `repr()` and `str()` (GH-22392)
...
* Enum: streamline repr() and str(); improve docs
- repr() is now ``enum_class.member_name``
- stdlib global enums are ``module_name.member_name``
- str() is now ``member_name``
- add HOW-TO section for ``Enum``
- change main documentation to be an API reference
2021-03-30 21:17:26 -07:00
b05b48dd7a
bpo-43571: Add IPPROTO_MPTCP macro (GH-24946)
...
Add IPPROTO_MPTCP constant when defined in the system headers.
2021-03-20 15:04:56 -07:00
f4936ad1c4
bpo-42393: Raise OverflowError iso. DeprecationWarning on overflow in socket.ntohs and socket.htons (GH-23980)
2020-12-31 15:16:50 +02:00
96a09df644
[doc] Fix a few margins due to bad markup (GH-23619)
2020-12-17 09:25:55 -08:00
03c8ddd9e9
bpo-42413: socket.timeout is now an alias of TimeoutError (GH-23413)
...
Signed-off-by: Christian Heimes <christian@python.org>
2020-11-20 00:26:07 -08:00
f85658a098
bpo-40901: Describe what "interface name" means on Windows (GH-20694)
2020-10-19 23:30:58 +01:00
d3ded08048
bpo-40204: Add :noindex: in the documentation (GH-21859)
...
Add :noindex: to duplicated documentation to fix "duplicate object
description" errors.
For example, fix this Sphinx 3 issue:
Doc/library/configparser.rst:1146: WARNING: duplicate object
description of configparser.ConfigParser.optionxform, other instance
in library/configparser, use :noindex: for one of them
2020-08-13 21:41:54 +02:00
360371f79c
bpo-40291: Add support for CAN_J1939 sockets (GH-19538)
...
Add support for CAN_J1939 sockets that wrap SAE J1939 protocol
functionality provided by Linux 5.4+ kernels.
2020-04-29 15:31:19 -07:00
97e0de04b8
bpo-25780: Expose CAN_RAW_JOIN_FILTERS in the socket module (GH-19190)
...
Co-Authored-By: Stefan Tatschner <stefan@rumpelsepp.org>
2020-04-09 13:03:49 +01:00
Miss Islington (bot)