Better document rule processing order

Close #2040
This commit is contained in:
Fredrick Brennan 2020-08-12 09:33:41 -07:00 committed by GitHub
parent 81d0042a9e
commit 66a40e039d
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -81,7 +81,7 @@ Methods
location. Returns None if there isn't one. location. Returns None if there isn't one.
- ``normalizeLocation(aLocation)``: return a dict with normalized axis values. - ``normalizeLocation(aLocation)``: return a dict with normalized axis values.
- ``normalize()``: normalize the geometry of this designspace: scale all the - ``normalize()``: normalize the geometry of this designspace: scale all the
locations of all masters and instances to the ``-1 - 0 - 1`` value. locations of all masters and instances to the ``-1 - 0 - 1`` value.
- ``loadSourceFonts()``: Ensure SourceDescriptor.font attributes are loaded, - ``loadSourceFonts()``: Ensure SourceDescriptor.font attributes are loaded,
and return list of fonts. and return list of fonts.
- ``tostring(encoding=None)``: Returns the designspace as a string. Default - ``tostring(encoding=None)``: Returns the designspace as a string. Default
@ -297,6 +297,8 @@ RuleDescriptor object
- Each condition is a dict with ``name``, ``minimum`` and ``maximum`` keys. - Each condition is a dict with ``name``, ``minimum`` and ``maximum`` keys.
- ``subs``: list of substitutions - ``subs``: list of substitutions
- Each substitution is stored as tuples of glyphnames, e.g. ("a", "a.alt"). - Each substitution is stored as tuples of glyphnames, e.g. ("a", "a.alt").
- Note: By default, rules are applied *before* text shaping/OpenType layout. See
`5.0 rules element`_.
Evaluating rules Evaluating rules
---------------- ----------------
@ -849,6 +851,7 @@ glyphname pairs: the glyphs that need to be substituted. For a rule to be trigge
**only one** of the conditionsets needs to be true, ``OR``. Within a conditionset **only one** of the conditionsets needs to be true, ``OR``. Within a conditionset
**all** conditions need to be true, ``AND``. **all** conditions need to be true, ``AND``.
.. attributes-11:
Attributes Attributes
---------- ----------