]> git.ipfire.org Git - thirdparty/Python/cpython.git/commitdiff
[3.10] GH-101111: Disambigaute origin of const for store_const and append_const ...
authorMiss Islington (bot) <31488909+miss-islington@users.noreply.github.com>
Fri, 20 Jan 2023 22:22:21 +0000 (14:22 -0800)
committerGitHub <noreply@github.com>
Fri, 20 Jan 2023 22:22:21 +0000 (23:22 +0100)
(cherry picked from commit 9a155138c58cad409e28e34359ba87ec0025b6b7)

While the documentation for `optparse` mentioned that both `store_const` and
`append_const` store a constant value, it was not clear where this value was
coming from.

A link to `Option.const` makes this explicit.

Co-authored-by: Jürgen Gmach <juergen.gmach@googlemail.com>
Doc/library/optparse.rst

index 47e62553fb0358851b47549b529a188cc5c7c03f..3e29fed0175e04f05b6914a77b7ccac62ede40ab 100644 (file)
@@ -404,7 +404,7 @@ Other actions
 Some other actions supported by :mod:`optparse` are:
 
 ``"store_const"``
-   store a constant value
+   store a constant value, pre-set via :attr:`Option.const`
 
 ``"append"``
    append this option's argument to a list
@@ -925,7 +925,7 @@ The canonical way to create an :class:`Option` instance is with the
       store this option's argument (default)
 
    ``"store_const"``
-      store a constant value
+      store a constant value, pre-set via :attr:`Option.const`
 
    ``"store_true"``
       store ``True``
@@ -937,7 +937,7 @@ The canonical way to create an :class:`Option` instance is with the
       append this option's argument to a list
 
    ``"append_const"``
-      append a constant value to a list
+      append a constant value to a list, pre-set via :attr:`Option.const`
 
    ``"count"``
       increment a counter by one