From 6721ffd7075ff5357e0c19dd20e123d068cddce4 Mon Sep 17 00:00:00 2001 From: Michael Merickel Date: Thu, 15 Dec 2016 00:33:48 -0600 Subject: improve config_vars docs in some scripts to mirror pserve --- pyramid/scripts/prequest.py | 7 ++++--- pyramid/scripts/proutes.py | 7 ++++--- pyramid/scripts/ptweens.py | 5 +++-- 3 files changed, 11 insertions(+), 8 deletions(-) diff --git a/pyramid/scripts/prequest.py b/pyramid/scripts/prequest.py index 1136dd409..aefb4e18d 100644 --- a/pyramid/scripts/prequest.py +++ b/pyramid/scripts/prequest.py @@ -104,9 +104,10 @@ class PRequestCommand(object): 'config_vars', nargs='*', default=(), - help='Arbitrary options to override those in the [app:main] section ' - 'of the configuration file.', - ) + help="Variables required by the config file. For example, " + "`http_port=%%(http_port)s` would expect `http_port=8080` to be " + "passed here.", + ) get_app = staticmethod(get_app) stdin = sys.stdin diff --git a/pyramid/scripts/proutes.py b/pyramid/scripts/proutes.py index df8e51e39..2a999e04f 100644 --- a/pyramid/scripts/proutes.py +++ b/pyramid/scripts/proutes.py @@ -276,9 +276,10 @@ class PRoutesCommand(object): 'config_vars', nargs='*', default=(), - help='Arbitrary options to override those in the [app:main] section ' - 'of the configuration file.', - ) + help="Variables required by the config file. For example, " + "`http_port=%%(http_port)s` would expect `http_port=8080` to be " + "passed here.", + ) def __init__(self, argv, quiet=False): self.args = self.parser.parse_args(argv[1:]) diff --git a/pyramid/scripts/ptweens.py b/pyramid/scripts/ptweens.py index 348f2b372..f278a0370 100644 --- a/pyramid/scripts/ptweens.py +++ b/pyramid/scripts/ptweens.py @@ -40,8 +40,9 @@ class PTweensCommand(object): 'config_vars', nargs='*', default=(), - help='Arbitrary options to override those in the [app:main] section ' - 'of the configuration file.', + help="Variables required by the config file. For example, " + "`http_port=%%(http_port)s` would expect `http_port=8080` to be " + "passed here.", ) stdout = sys.stdout -- cgit v1.2.3