Skip to content

[3.14] Reword atexit docs (GH-156086) - #156879

Merged
encukou merged 1 commit into
python:3.14from
miss-islington:backport-1d28836-3.14
Sep 3, 2026
Merged

[3.14] Reword atexit docs (GH-156086)#156879
encukou merged 1 commit into
python:3.14from
miss-islington:backport-1d28836-3.14

Conversation

@miss-islington

Copy link
Copy Markdown
Contributor

For the atexit module:

  • Move common info from register to the module level (a lot of this
    was duplicated -- less maintainable and harder to read)
  • Use interpreter shutdown consistently, introducing it as a more
    general term for the old docs' program termination.
  • Use the term exit handler consistently
  • Move warning for a mitigated footgun to a change entry
  • Add a new warning about keeping things usable

Similarly clarify docs for the atexit attribute in weakref.
(cherry picked from commit 1d28836)

Co-authored-by: Petr Viktorin encukou@gmail.com

For the `atexit` module:

- Move common info from `register` to the module level (a lot of this
  was duplicated -- less maintainable and harder to read)
- Use *interpreter shutdown* consistently, introducing it as a more
  general term for the old docs' *program termination*.
- Use the term *exit handler* consistently
- Move warning for a mitigated footgun to a change entry
- Add a new warning about keeping things usable

Similarly clarify docs for the `atexit` attribute in `weakref`.
(cherry picked from commit 1d28836)

Co-authored-by: Petr Viktorin <encukou@gmail.com>
@encukou
encukou merged commit 80f9604 into python:3.14 Sep 3, 2026
40 checks passed
@github-project-automation github-project-automation Bot moved this from Todo to Done in Docs PRs Sep 3, 2026
@miss-islington
miss-islington deleted the backport-1d28836-3.14 branch September 3, 2026 10:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docs Documentation in the Doc dir skip issue skip news

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

2 participants