instancer: mention special None and 'drop' in docstring and --help

This commit is contained in:
Cosimo Lupo 2019-05-21 14:40:26 -04:00
parent 0e9c5d9fe8
commit 058165dc5c
No known key found for this signature in database
GPG Key ID: 179A8F0895A02F4F

View File

@ -778,9 +778,10 @@ def parseArgs(args):
Returns: Returns:
3-tuple (infile, axis_limits, options) 3-tuple (infile, axis_limits, options)
axis_limits is either a Dict[str, int], for pinning variation axes to specific axis_limits is either a Dict[str, Optional[float]], for pinning variation axes
coordinates along those axes; or a Dict[str, Tuple(int, int)], meaning limit to specific coordinates along those axes (with `None` as a placeholder for an
this axis to min/max range. axis' default value); or a Dict[str, Tuple(float, float)], meaning limit this
axis to min/max range.
Axes locations are in user-space coordinates, as defined in the "fvar" table. Axes locations are in user-space coordinates, as defined in the "fvar" table.
""" """
from fontTools import configLogger from fontTools import configLogger
@ -796,8 +797,9 @@ def parseArgs(args):
metavar="AXIS=LOC", metavar="AXIS=LOC",
nargs="*", nargs="*",
help="List of space separated locations. A location consist in " help="List of space separated locations. A location consist in "
"the tag of a variation axis, followed by '=' and a number or" "the tag of a variation axis, followed by '=' and one of number, "
"number:number. E.g.: wdth=100 or wght=75.0:125.0", "number:number or the literal string 'drop'. "
"E.g.: wdth=100 or wght=75.0:125.0 or wght=drop",
) )
parser.add_argument( parser.add_argument(
"-o", "-o",