summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorMiss Islington (bot) <31488909+miss-islington@users.noreply.github.com>2024-01-31 21:40:20 (GMT)
committerGitHub <noreply@github.com>2024-01-31 21:40:20 (GMT)
commite66ad91f68b68fc8cbdc4b6dacea80636164cdf5 (patch)
treee967b89d53312134b531f86ec936e9da136a3485
parent8e323cb68bae9681dcd38a6aa8c37bc0f50de05c (diff)
downloadcpython-e66ad91f68b68fc8cbdc4b6dacea80636164cdf5.zip
cpython-e66ad91f68b68fc8cbdc4b6dacea80636164cdf5.tar.gz
cpython-e66ad91f68b68fc8cbdc4b6dacea80636164cdf5.tar.bz2
[3.11] Add note to `sys.orig_argv` clarifying the difference from `sys.argv` (GH-114630) (#114822)
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>
-rw-r--r--Doc/library/sys.rst5
1 files changed, 4 insertions, 1 deletions
diff --git a/Doc/library/sys.rst b/Doc/library/sys.rst
index 2a1e6fb..e402d8b 100644
--- a/Doc/library/sys.rst
+++ b/Doc/library/sys.rst
@@ -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