From ed9c0185d80514670244b0c2147958dea00159a9 Mon Sep 17 00:00:00 2001 From: Damien George Date: Thu, 15 Aug 2019 17:42:38 +1000 Subject: [PATCH] docs/library/sys: Add documentation for sys.atexit function. --- docs/library/sys.rst | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/docs/library/sys.rst b/docs/library/sys.rst index f2d96cb8cc..aee2e54ee6 100644 --- a/docs/library/sys.rst +++ b/docs/library/sys.rst @@ -15,6 +15,19 @@ Functions function raise as `SystemExit` exception. If an argument is given, its value given as an argument to `SystemExit`. +.. function:: atexit(func) + + Register *func* to be called upon termination. *func* must be a callable + that takes no arguments, or ``None`` to disable the call. The ``atexit`` + function will return the previous value set by this function, which is + initially ``None``. + + .. admonition:: Difference to CPython + :class: attention + + This function is a MicroPython extension intended to provide similar + functionality to the :mod:`atexit` module in CPython. + .. function:: print_exception(exc, file=sys.stdout) Print exception with a traceback to a file-like object *file* (or