]> git.ipfire.org Git - thirdparty/Python/cpython.git/commitdiff
bpo-19184: Update the documentation of dis module. (GH-13652) (GH-13755)
authorMiss Islington (bot) <31488909+miss-islington@users.noreply.github.com>
Sun, 2 Jun 2019 23:18:50 +0000 (16:18 -0700)
committerEzio Melotti <ezio.melotti@gmail.com>
Sun, 2 Jun 2019 23:18:50 +0000 (01:18 +0200)
* bpo-19184: Update the documentation of dis module

* Explain the behavior of the number of arguments of RAISE_VARGARGS
  opcode.

* bpo-19184: Update blurb.

* bpo-19184: Fix typo in the dis Documentation.

* bpo-19184: Address review comments and improve the doc

* bpo-19184: Remove news file.
(cherry picked from commit e1179a5096fb12297ececd7a1c79969aa5747e28)

Co-authored-by: Michele Angrisano <michele.angrisano@gmail.com>
Doc/library/dis.rst

index 6bbef3844de5ae726344c3a9bd217cba4f5f9f78..b8cf4463d9355bc5de1cf6bdac34c5bd4d5b1667 100644 (file)
@@ -1059,9 +1059,13 @@ All of the following opcodes use their arguments.
 
 .. opcode:: RAISE_VARARGS (argc)
 
-   Raises an exception. *argc* indicates the number of arguments to the raise
-   statement, ranging from 0 to 3.  The handler will find the traceback as TOS2,
-   the parameter as TOS1, and the exception as TOS.
+   Raises an exception using one of the 3 forms of the ``raise`` statement,
+   depending on the value of *argc*:
+
+   * 0: ``raise`` (re-raise previous exception)
+   * 1: ``raise TOS`` (raise exception instance or type at ``TOS``)
+   * 2: ``raise TOS1 from TOS`` (raise exception instance or type at ``TOS1``
+     with ``__cause__`` set to ``TOS``)
 
 
 .. opcode:: CALL_FUNCTION (argc)