aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorIan Rodney <ian.rodney@gmail.com>2021-10-18 01:52:00 -0700
committerGitHub <noreply@github.com>2021-10-18 01:52:00 -0700
commite2b3c98cd8c67b702be1b711c06ee7b9bbedb8ba (patch)
tree6741f6d3708cb7c27f87d8c9d674da90d24867cb
parenta4cf9b1bf461a3fb35432e42f4d8bc1a8ff7bc97 (diff)
downloadgoogle-auth-library-python-e2b3c98cd8c67b702be1b711c06ee7b9bbedb8ba.tar.gz
docs: Fix formatting of `GCE_METADATA_HOST` (#890)
* Clean docs up * Update google/auth/environment_vars.py Co-authored-by: arithmetic1728 <58957152+arithmetic1728@users.noreply.github.com>
-rw-r--r--google/auth/environment_vars.py10
1 files changed, 6 insertions, 4 deletions
diff --git a/google/auth/environment_vars.py b/google/auth/environment_vars.py
index d36d6c4..c076dc5 100644
--- a/google/auth/environment_vars.py
+++ b/google/auth/environment_vars.py
@@ -41,15 +41,17 @@ files."""
# These two variables allow for customization of the addresses used when
# contacting the GCE metadata service.
GCE_METADATA_HOST = "GCE_METADATA_HOST"
-GCE_METADATA_ROOT = "GCE_METADATA_ROOT"
"""Environment variable providing an alternate hostname or host:port to be
used for GCE metadata requests.
-This environment variable is originally named GCE_METADATA_ROOT. System will
-check the new variable first; should there be no value present,
-the system falls back to the old variable.
+This environment variable was originally named GCE_METADATA_ROOT. The system will
+check this environemnt variable first; should there be no value present,
+the system will fall back to the old variable.
"""
+GCE_METADATA_ROOT = "GCE_METADATA_ROOT"
+"""Old environment variable for GCE_METADATA_HOST."""
+
GCE_METADATA_IP = "GCE_METADATA_IP"
"""Environment variable providing an alternate ip:port to be used for ip-only
GCE metadata requests."""