summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMichael Merickel <michael@merickel.org>2016-12-15 00:33:48 -0600
committerMichael Merickel <michael@merickel.org>2016-12-15 00:33:48 -0600
commit6721ffd7075ff5357e0c19dd20e123d068cddce4 (patch)
treed56f818235a53096309a0cc968ca367ae2941a52
parent4c8eb258689df43fa7ded99e4e781712a9106752 (diff)
downloadpyramid-6721ffd7075ff5357e0c19dd20e123d068cddce4.tar.gz
pyramid-6721ffd7075ff5357e0c19dd20e123d068cddce4.tar.bz2
pyramid-6721ffd7075ff5357e0c19dd20e123d068cddce4.zip
improve config_vars docs in some scripts to mirror pserve
-rw-r--r--pyramid/scripts/prequest.py7
-rw-r--r--pyramid/scripts/proutes.py7
-rw-r--r--pyramid/scripts/ptweens.py5
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