Commit Graph

970 Commits

Author SHA1 Message Date
Miss Islington (bot) e69ecfee5e
[3.13] gh-134835: Remove outdated list from `howto/urllib2.rst` (GH-134844) (#134985)
gh-134835: Remove outdated list from `howto/urllib2.rst` (GH-134844)

🫖
(cherry picked from commit 3704171415)

Co-authored-by: Stan Ulbrych <89152624+StanFromIreland@users.noreply.github.com>
2025-05-31 17:54:38 +00:00
Miss Islington (bot) d6e4786937
[3.13] gh-133678: Document C API third party tools (GH-134526) (#134792)
gh-133678: Document C API third party tools (GH-134526)
(cherry picked from commit c3c88064f5)

Co-authored-by: Victor Stinner <vstinner@python.org>
Co-authored-by: Petr Viktorin <encukou@gmail.com>
Co-authored-by: Steve Dower <steve.dower@python.org>
2025-05-27 15:44:44 +00:00
Miss Islington (bot) 698bf97274
[3.13] gh-134595: Update HOWTO to reflect change in CIBW option (GH-134598) (#134623)
Co-authored-by: Jasper Wong <111284156+3willows@users.noreply.github.com>
2025-05-24 07:21:14 +00:00
Miss Islington (bot) c6497d632d
[3.13] Add notes on nogil & reinitialization to the Opt-Out section in Module Isolation HOWTO (GH-134141) (GH-134491)
Add notes on nogil & reinitialization to the Opt-Out section in Module Isolation HOWTO (GH-134141)
(cherry picked from commit 1f0a294e8c)

Co-authored-by: Petr Viktorin <encukou@gmail.com>
Co-authored-by: Sam Gross <colesbury@gmail.com>
2025-05-23 10:46:58 +02:00
Miss Islington (bot) 1a61d81544
[3.13] Docs: fix link in free-threading-python.rst (GH-134548) (#134556) 2025-05-23 00:43:26 +00:00
Miss Islington (bot) ca2e1a1e1c
[3.13] gh-130861: Add clarification to the perf docs on optimization levels (GH-131098) (#132687) 2025-04-18 13:48:23 +00:00
Miss Islington (bot) fc85256f89
[3.13] Fix example code in curses tutorial (GH-126446) (#132362)
Co-authored-by: Jiayu Yi <yijiayu@gmail.com>
2025-04-10 12:13:50 +00:00
Miss Islington (bot) 7f7fc549b4
[3.13] gh-118518: Minor improvements to perf docs (GH-130866) (#131059)
gh-118518: Minor improvements to perf docs (GH-130866)

Minor improvements to perf docs
(cherry picked from commit ecdf6b15b0)

Co-authored-by: stratakis <cstratak@redhat.com>
2025-03-28 11:42:58 +00:00
Miss Islington (bot) 0a992ff383
[3.13] [doc]: Update logging cookbook to mention domain socket configuration in a recipe. (GH-130348) (GH-130351)
(cherry picked from commit 8cbcf51d61)
2025-02-20 14:20:26 +00:00
Serhiy Storchaka 4cf3e80eee
[3.13] Use roles :data: and :const: for referencing module variables (GH-129507) (GH-129649)
(cherry picked from commit 078ab828b9)
2025-02-04 14:25:18 +00:00
Miss Islington (bot) 8ab29d95a2
[3.13] Docs: fix typo in `Doc/howto/mro.rst` (GH-129095) (GH-129122)
(cherry picked from commit da310d209a)

Co-authored-by: smelnikov <13030121+smelnikov@users.noreply.github.com>
2025-01-21 10:40:31 +01:00
Miss Islington (bot) 6f3c2c8d04
[3.13] gh-126180: Remove getopt and optparse deprecation notices (GH-128191)
* Remove getopt and optparse deprecation notices
* Add new docs sections for command line app helper libraries
* Add guidance on choosing a CLI parsing library to the optparse docs
* Link to the new guidance from the argparse and getopt docs
* Reword intro in docs section for superseded stdlib modules
* Reframe the optparse->argparse guide as a migration guide
  rather than as an upgrade guide

---------
(cherry picked from commit 831b6de6d7)

Co-authored-by: Alyssa Coghlan <ncoghlan@gmail.com>
Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
2024-12-23 04:40:59 +00:00
Miss Islington (bot) 304111e967
[3.13] [Docs] GDB howto: Fix block type of a cast example (GH-127621) (#127653)
[Docs] GDB howto: Fix block type of a cast example (GH-127621)
(cherry picked from commit 657d0e99aa)

Co-authored-by: Maciej Olko <maciej.olko@affirm.com>
2024-12-05 20:58:36 +00:00
Miss Islington (bot) 8b2e30390c
[3.13] gh-101100: Fix sphinx warnings in `howto/*` (GH-127084) (#127287)
Co-authored-by: Yuki Kobayashi <drsuaimqjgar@gmail.com>
2024-11-26 08:27:25 +00:00
Miss Islington (bot) 29997c4fe5
[3.13] gh-48020: [docs] Remove the logging howto suggested future FileHandler multiprocessing support (GH-126531) (#126540)
gh-48020: [docs] Remove the logging howto suggested future FileHandler multiprocessing support (GH-126531)

Docs: Remove the logging howto potential promise of multiprocessing support in the future.

Stick to the facts and suggestions, don't provide hope where we're not going to
implement complexity that we'd rather the user implement themselves when
needed.
(cherry picked from commit 1fe67df8e3)

Co-authored-by: Gregory P. Smith <greg@krypto.org>
2024-11-07 10:03:58 +00:00
Miss Islington (bot) 253d69feb1
[3.13] gh-95836: Add custom type converter examples to argparse tutorial (GH-125376) (GH-125643)
(cherry picked from commit dbcc5ac470)

Co-authored-by: Savannah Ostrowski <savannahostrowski@gmail.com>
2024-10-17 15:43:08 +03:00
Savannah Ostrowski 5f2a5ac9dc
[3.13] GH-124478: Cleanup argparse documentation (GH-124877) (#125162)
(cherry picked from commit 37228bd16e)

Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
Co-authored-by: Tomas R <tomas.roun8@gmail.com>
2024-10-08 16:20:01 -07:00
Miss Islington (bot) 4ff32aac9e
[3.13] gh-124370: Add "howto" for free-threaded Python (GH-124371) (#124860)
gh-124370: Add "howto" for free-threaded Python (GH-124371)
(cherry picked from commit 68e384c217)

Co-authored-by: Sam Gross <colesbury@gmail.com>
Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>
Co-authored-by: mpage <mpage@cs.stanford.edu>
Co-authored-by: Carol Willing <carolcode@willingconsulting.com>
2024-10-03 09:24:42 -07:00
Alex Waygood 9f2e6ca199
[3.13] gh-101100: Add a table of class attributes to the "Custom classes" section of the data model docs (#124480) (#124556) 2024-09-25 17:29:48 -07:00
Miss Islington (bot) d4225b6322
[3.13] GH-101599: Update docs to remove redundant option in argparse tutorial (GH-124025) (#124037)
GH-101599: Update docs to remove redundant option in argparse tutorial (GH-124025)
(cherry picked from commit e5b0185e43)

Co-authored-by: Savannah Ostrowski <savannahostrowski@gmail.com>
2024-09-23 17:31:56 -07:00
Miss Islington (bot) 181c2b8669
[3.13] gh-119802: Update memory management docs for free-threaded build (gh-124006) (#124054)
gh-119802: Update memory management docs for free-threaded build (gh-124006)

* gh-119802: Update memory management docs for free-threaded build

* nit

* nit

* Address code review

* nit

* Update Doc/c-api/memory.rst



---------

(cherry picked from commit e6bb1a2b28)

Co-authored-by: Donghee Na <donghee.na@python.org>
Co-authored-by: Sam Gross <colesbury@gmail.com>
2024-09-23 17:31:01 -07:00
Miss Islington (bot) b2ffd492cd
[3.13] Minor edits to the descriptor guide (GH-123928) (#124079)
Minor edits to the descriptor guide (GH-123928)
(cherry picked from commit cd06f5e323)

Co-authored-by: Raymond Hettinger <rhettinger@users.noreply.github.com>
2024-09-23 11:07:56 -07:00
Miss Islington (bot) 66b15381f1
[3.13] gh-109975: Add links to py-free-threading.github.io (GH-123776) (#123794)
Co-authored-by: Nathan Goldbaum <nathan.goldbaum@gmail.com>
Co-authored-by: Victor Stinner <vstinner@python.org>
2024-09-06 20:46:40 +03:00
Miss Islington (bot) 402b5f204a
[3.13] gh-123463: Include logging_flow diagram in non-HTML docs (GH-123464) (#123666)
(cherry picked from commit 7d2c2f24da)

Co-authored-by: Alexander Bessman <bessman@users.noreply.github.com>
2024-09-06 15:44:07 +02:00
Wei-Hsiang (Matt) Wang 05dcc81601
[3.13] gh-123517: Remove unnecessary `:meth:` parentheses (gh-123518) (GH-123577) 2024-09-02 16:00:04 +02:00
Alex Waygood 3455d8560a
[3.13] Fix typos in docs, error messages and comments (#122502) (#122606)
Fix typos in docs, error messages and comments (#122502)

(cherry-picked from commit 46f5a4f9e1)

Signed-off-by: jianghuyiyuan <shuangcui@live.com>
Co-authored-by: jianghuyiyuan <shuangcui@live.com>
2024-09-02 12:44:42 +02:00
Miss Islington (bot) 364d366328
[3.13] Remove irrelevant detail from example code. (gh-123587) (gh-123588) 2024-09-01 20:27:48 -05:00
Miss Islington (bot) 767dfb9e8d
[3.13] Simplify Property() recipe to focus on the essentials (gh-123585) (gh-123586) 2024-09-01 18:08:21 -05:00
Wei-Hsiang (Matt) Wang 9f5f2b7128
[3.13] gh-123492: Remove unnecessary `:func:` parentheses (gh-123493) (#123513) 2024-08-30 20:14:48 +03:00
Miss Islington (bot) 3ae1236c73
[3.13] Docs: spelling and grammar fixes (GH-122084) (#122106)
Docs: spelling and grammar fixes (GH-122084)

Corrected some grammar and spelling issues in documentation.

(cherry picked from commit bc264eac3a)

Co-authored-by: Ville Skyttä <ville.skytta@iki.fi>
Co-authored-by: Russell Keith-Magee <russell@keith-magee.com>
Co-authored-by: Bénédikt Tran <10796600+picnixz@users.noreply.github.com>
2024-07-22 01:30:34 +00:00
Vinay Sajip 253c033251
[3.13] gh-121035: Update PNG image for logging flow diagram. (GH-121323) (GH-121324)
(cherry picked from commit 26d24eeb90)
2024-07-03 13:01:34 +01:00
Vinay Sajip 3302c5f155
[3.13] gh-121035: Further improve logging flow diagram with respect to dark/light modes. (GH-121265) (GH-121320)
[3.13] gh-121035: Further improve logging flow diagram with respect to dark/light modes. (GH-121265)
(cherry picked from commit 089835469d)
2024-07-03 11:41:18 +01:00
Vinay Sajip b62605d50f
[3.13] gh-121035: Improve logging flow diagram for dark/light modes. (GH-121254) (GH-121317)
(cherry picked from commit bfe0e4d769)
2024-07-03 11:01:50 +01:00
Miss Islington (bot) af89237c9c
[3.13] [doc] Update element positions and styles in logging flow diagram. (GH-121182) (GH-121183)
(cherry picked from commit 2a455bbe8f)
2024-06-30 15:06:27 +01:00
Miss Islington (bot) 49a01d6290
[3.13] gh-121035: Update logging flow chart to include the lastResort handler. (GH-121036) (GH-121106)
(cherry picked from commit 237baf4d7a)
2024-06-27 22:59:19 +01:00
Miss Islington (bot) 0a77058b79
[3.13] gh-120858: PyDict_Next should not lock the dict (GH-120859) (#120964)
PyDict_Next no longer locks the dictionary in the free-threaded build. Locking
around individual PyDict_Next calls is not sufficient because the function
returns borrowed references and because it allows concurrent modifications
during the iteraiton loop.

The internal locking also interferes with correct external synchronization
because it may suspend outer critical sections created by the caller.
(cherry picked from commit 375b723d58)

Co-authored-by: Sam Gross <colesbury@gmail.com>
2024-06-24 18:41:19 +00:00
Miss Islington (bot) d0a5e40f01
[3.13] Update the documentation howto index page and group docs into 3 logical sections (GH-119366, GH-120703) (GH-120646)
Update the documentation howto index page and group docs into 3 logical sections (GH-119366)

(cherry picked from commit a26d27e7ee)

Includes a follow-up fix to properly merge GH-119877:
* Add a link to free-threading HOWTO to the index (GH-120703)
  (cherry picked from commit 45d5cab533)

Co-authored-by: Carol Willing <carolcode@willingconsulting.com>
Co-authored-by: Ned Batchelder <ned@nedbatchelder.com>
2024-06-20 10:24:14 +00:00
Miss Islington (bot) e415d2561b
[3.13] gh-118820: Zero-valued flag enum has no name (GH-118848) (GH-120759)
gh-118820: Zero-valued flag enum has no name (GH-118848)
(cherry picked from commit ed5ae6c4d7)

Co-authored-by: Nice Zombies <nineteendo19d0@gmail.com>
Co-authored-by: Bénédikt Tran <10796600+picnixz@users.noreply.github.com>
2024-06-19 15:11:30 -07:00
Miss Islington (bot) 8c129d99ef
[3.13] gh-119241: Add HOWTO for free-threaded C API extensions (GH-119877) (#120693)
Some sections adapted from https://github.com/Quansight-Labs/free-threaded-compatibility/
written by Nathan Goldbaum.

(cherry picked from commit 02b272b702)

Co-authored-by: Sam Gross <colesbury@gmail.com>
Co-authored-by: Nathan Goldbaum <nathan.goldbaum@gmail.com>
2024-06-18 14:28:51 +00:00
Miss Islington (bot) f0788cb419
[3.13] gh-120345: Fix incorrect use of the :class: role with the "()" suffix (GH-120347) (GH-120411)
* Remove "()" when refer to a class as a type.
* Use :func: when refer to a callable.
* Fix reference to the datetime.astimezone() method.
(cherry picked from commit 92c9c6ae14)

Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
2024-06-12 14:51:35 +00:00
Miss Islington (bot) a7327b31e3
[3.13] gh-119779: Fix pyporting howto docs (GH-119785) (#119788)
gh-119779: Fix pyporting howto docs (GH-119785)
(cherry picked from commit 6fb191be15)

Co-authored-by: Awbert <119314310+SweetyAngel@users.noreply.github.com>
2024-05-30 16:09:31 +00:00
Miss Islington (bot) 3f0198d927
[3.13] docs: fix a few typos identified by codespell (GH-119516) (#119570)
Co-authored-by: Ned Batchelder <ned@nedbatchelder.com>
2024-05-26 08:20:37 +00:00
trag1c c4f9823be2
gh-118671: Updated dead ActiveState links (#118730)
Co-authored-by: blurb-it[bot] <43283697+blurb-it[bot]@users.noreply.github.com>
Co-authored-by: Kirill Podoprigora <kirill.bast9@mail.ru>
2024-05-08 01:06:38 -06:00
Pablo Galindo Salgado b9caa0977c
gh-118518: Improve perf docs (#118708) 2024-05-07 17:25:15 +01:00
Hugo van Kemenade 04859228aa
gh-118518: Rename `PYTHONPERFJITSUPPORT` and `-X perfjit` with underscores (#118693) 2024-05-07 11:47:21 +00:00
Pablo Galindo Salgado 1b22d801b8
gh-118518: Allow perf to work without frame pointers (#112254) 2024-05-05 03:07:29 +02:00
Xie Yanbo 0315521c52
Fix typo in Doc/howto/timerfd.rst (GH-118376) 2024-04-29 14:01:03 +03:00
Hugo van Kemenade 3375282bb8
Docs: add link roles with Sphinx extlinks (#117850)
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
2024-04-15 21:22:00 +03:00
Hugo van Kemenade 7d0be7aea5
Add 'The Python 2.3 Method Resolution Order' (#116435) 2024-04-15 13:01:15 +03:00
Vinay Sajip df912c913a
[doc] Update logging documentation to improve grammar and elucidate an example. (GH-117541) 2024-04-04 13:14:44 +01:00