shadowfacts/fonttools
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

[designspaceLib] Documentation: Clarify what min/max/default on an AxisDescriptor mean (#1395)

Browse Source 
Clarify that the axis properties refer to user space coordinates
This commit is contained in:
Nikolaus Waxweiler 2018-12-19 11:24:07 +00:00 committed by GitHub
parent f998688c00
commit 621c652ad0
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 10 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
Doc/source/designspaceLib/readme.rst
View File

@ -278,16 +278,17 @@ AxisDescriptor object
- ``labelNames``: dict. When defining a non-registered axis, it will be - ``labelNames``: dict. When defining a non-registered axis, it will be
necessary to define user-facing readable names for the axis. Keyed by necessary to define user-facing readable names for the axis. Keyed by
xml:lang code. Varlib. xml:lang code. Varlib.
- ``minimum``: number. The minimum value for this axis. MutatorMath + - ``minimum``: number. The minimum value for this axis in user space.
Varlib.
- ``maximum``: number. The maximum value for this axis. MutatorMath +
Varlib.
- ``default``: number. The default value for this axis, i.e. when a new
location is created, this is the value this axis will get.
MutatorMath + Varlib. MutatorMath + Varlib.
- ``map``: list of input / output values that can describe a warp of - ``maximum``: number. The maximum value for this axis in user space.
user space to designspace coordinates. If no map values are present, MutatorMath + Varlib.
it is assumed it is [(minimum, minimum), (maximum, maximum)]. Varlib. - ``default``: number. The default value for this axis, i.e. when a new
location is created, this is the value this axis will get in user
space. MutatorMath + Varlib.
- ``map``: list of input / output values that can describe a warp of user space
to design space coordinates. If no map values are present, it is assumed user
space is the same as design space, as in [(minimum, minimum), (maximum, maximum)].
Varlib.
.. code:: python .. code:: python