Skip to content

[3.15] Reword atexit docs (GH-156086) - #156878

Open
miss-islington wants to merge 1 commit into
python:3.15from
miss-islington:backport-1d28836-3.15
Open

[3.15] Reword atexit docs (GH-156086)#156878
miss-islington wants to merge 1 commit into
python:3.15from
miss-islington:backport-1d28836-3.15

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>
@read-the-docs-community

Copy link
Copy Markdown

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

Status: Todo

Development

Successfully merging this pull request may close these issues.

2 participants