cpython/Doc/howto
Miss Islington (bot) a7246323a2
[3.13] gh-135110: Fix misleading generator.close() documentation (GH-135152) (GH-135986)
gh-135110: Fix misleading `generator.close()` documentation (GH-135152)

The documentation incorrectly stated that generator.close() 'raises' a
GeneratorExit exception. This was misleading because the method doesn't
raise the exception to the caller - it sends the exception internally
to the generator and returns None.
(cherry picked from commit 0d76dccc3b)

Co-authored-by: Connor Denihan <188690869+cdenihan@users.noreply.github.com>
2025-06-26 13:34:11 +00:00
..
annotations.rst [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
argparse-optparse.rst [3.13] gh-126180: Remove getopt and optparse deprecation notices (GH-128191) 2024-12-23 04:40:59 +00:00
argparse.rst [3.13] gh-126180: Remove getopt and optparse deprecation notices (GH-128191) 2024-12-23 04:40:59 +00:00
clinic.rst GH-107518: Remove the Argument Clinic How-To (#109900) 2023-10-11 14:57:51 +02:00
cporting.rst [3.13] gh-133678: Document C API third party tools (GH-134526) (#134792) 2025-05-27 15:44:44 +00:00
curses.rst [3.13] Fix example code in curses tutorial (GH-126446) (#132362) 2025-04-10 12:13:50 +00:00
descriptor.rst [3.13] gh-101100: Fix sphinx warnings in howto/* (GH-127084) (#127287) 2024-11-26 08:27:25 +00:00
enum.rst [3.13] gh-101100: Fix sphinx warnings in howto/* (GH-127084) (#127287) 2024-11-26 08:27:25 +00:00
free-threading-extensions.rst [3.13] gh-135151: Fix incorrect packaging of pyconfig.h in Windows installer (GH-135180) 2025-06-05 23:03:38 +01:00
free-threading-python.rst [3.13] Docs: fix link in free-threading-python.rst (GH-134548) (#134556) 2025-05-23 00:43:26 +00:00
functional.rst [3.13] gh-135110: Fix misleading generator.close() documentation (GH-135152) (GH-135986) 2025-06-26 13:34:11 +00:00
gdb_helpers.rst [3.13] [Docs] GDB howto: Fix block type of a cast example (GH-127621) (#127653) 2024-12-05 20:58:36 +00:00
index.rst [3.13] gh-124370: Add "howto" for free-threaded Python (GH-124371) (#124860) 2024-10-03 09:24:42 -07:00
instrumentation.rst [3.13] gh-123492: Remove unnecessary :func: parentheses (gh-123493) (#123513) 2024-08-30 20:14:48 +03:00
ipaddress.rst bpo-44740: Make minor edits to lowercasing "internet" and "web". (GH-27385) 2021-07-27 10:57:52 +02:00
isolating-extensions.rst [3.13] gh-135965: Delete duplicate word in isolating-extensions howto (GH-135964) (#135978) 2025-06-26 11:47:47 +00:00
logging-cookbook.rst [3.13] [doc]: Update logging cookbook to mention domain socket configuration in a recipe. (GH-130348) (GH-130351) 2025-02-20 14:20:26 +00:00
logging.rst [3.13] gh-123463: Include logging_flow diagram in non-HTML docs (GH-123464) (#123666) 2024-09-06 15:44:07 +02:00
logging_flow.png [3.13] gh-121035: Update PNG image for logging flow diagram. (GH-121323) (GH-121324) 2024-07-03 13:01:34 +01:00
logging_flow.svg [3.13] gh-121035: Further improve logging flow diagram with respect to dark/light modes. (GH-121265) (GH-121320) 2024-07-03 11:41:18 +01:00
mro.rst [3.13] Docs: fix typo in Doc/howto/mro.rst (GH-129095) (GH-129122) 2025-01-21 10:40:31 +01:00
perf_profiling.rst [3.13] gh-130861: Add clarification to the perf docs on optimization levels (GH-131098) (#132687) 2025-04-18 13:48:23 +00:00
pyporting.rst [3.13] gh-119779: Fix pyporting howto docs (GH-119785) (#119788) 2024-05-30 16:09:31 +00:00
regex.rst [3.13] Docs: Add missing lines between regex and text (GH-134505) (GH-135719) 2025-06-19 15:07:40 +00:00
sockets.rst Doc: Update references and examples of old, unsupported OSes and uarches (GH-92791) 2022-06-09 15:55:06 +02:00
sorting.rst Make the title match the content (GH-115702) 2024-02-20 01:51:56 -06:00
timerfd.rst Fix typo in Doc/howto/timerfd.rst (GH-118376) 2024-04-29 14:01:03 +03:00
unicode.rst gh-101100: Fix some broken sphinx references (#107095) 2023-07-23 03:23:44 -06:00
urllib2.rst [3.13] gh-134835: Remove outdated list from howto/urllib2.rst (GH-134844) (#134985) 2025-05-31 17:54:38 +00:00