]> granicus.if.org Git - python/commitdiff
bpo-19184: Update the documentation of dis module. (GH-13652)
authorMichele Angrisano <michele.angrisano@gmail.com>
Sun, 2 Jun 2019 21:34:12 +0000 (23:34 +0200)
committerEzio Melotti <ezio.melotti@gmail.com>
Sun, 2 Jun 2019 21:34:12 +0000 (23:34 +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.

Doc/library/dis.rst

index 060d4bb6997a4d52a1005fd11e8d4a993ea42d0f..15e707ae49f85fe70d81682fca34542fabca9821 100644 (file)
@@ -1113,9 +1113,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)