]> git.ipfire.org Git - thirdparty/Python/cpython.git/commitdiff
[3.11] Add note to `sys.orig_argv` clarifying the difference from `sys.argv` (GH...
authorMiss Islington (bot) <31488909+miss-islington@users.noreply.github.com>
Wed, 31 Jan 2024 21:40:20 +0000 (22:40 +0100)
committerGitHub <noreply@github.com>
Wed, 31 Jan 2024 21:40:20 +0000 (21:40 +0000)
Add note to `sys.orig_argv` clarifying the difference from `sys.argv` (GH-114630)
(cherry picked from commit 1836f674c0d86ec3375189a550c8f4a52ff89ae8)

Co-authored-by: Bradley Reynolds <bradley.reynolds@darbia.dev>
Co-authored-by: Ned Batchelder <ned@nedbatchelder.com>
Doc/library/sys.rst

index 2a1e6fb1a9cf2997d21b536d2c1e9abb98536e9e..e402d8b418b7b0b4d665d20b69c7f75e91eb8f91 100644 (file)
@@ -1240,7 +1240,10 @@ always available.
    The list of the original command line arguments passed to the Python
    executable.
 
-   See also :data:`sys.argv`.
+   The elements of :data:`sys.orig_argv` are the arguments to the Python interpreter,
+   while the elements of :data:`sys.argv` are the arguments to the user's program.
+   Arguments consumed by the interpreter itself will be present in :data:`sys.orig_argv`
+   and missing from :data:`sys.argv`.
 
    .. versionadded:: 3.10