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

[Doc/designspaceLib] mark rule 'name' as optional

Browse Source
This commit is contained in:
Cosimo Lupo 2018-05-03 11:51:18 +01:00
parent 162ad1c842
commit 23af3227b7
No known key found for this signature in database
GPG Key ID: 59D54DB0C9976482
1 changed files with 5 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -83,10 +83,10 @@ dictionary, ``obj.stylename`` and ``obj.localisedStyleName['en']``.
Rules Rules
***** *****
Rules describe designspace areas in which one glyph should be replaced by another. Rules describe designspace areas in which one glyph should be replaced by another.
A rule has a name and a number of conditionsets. The rule also contains a list of glyphname A rule has a name and a number of conditionsets. The rule also contains a list of glyphname
pairs: the glyphs that need to be substituted. For a rule to be triggered pairs: the glyphs that need to be substituted. For a rule to be triggered
only one of the conditionsets needs to be true, ``OR``. Within a conditionset all only one of the conditionsets needs to be true, ``OR``. Within a conditionset all
conditions need to be true, ``AND``. conditions need to be true, ``AND``.
Variable fonts Variable fonts
@ -309,9 +309,9 @@ AxisDescriptor object
RuleDescriptor object RuleDescriptor object
===================== =====================
- ``name``: string. Unique name for this rule. Will be used to - ``name``: string. Unique name for this rule. Can be used to
reference this rule data. reference this rule data.
- ``conditionSets``: a list conditionsets - ``conditionSets``: a list of conditionsets
- Each conditionset is a list of conditions. - Each conditionset is a list of conditions.
- Each condition is a dict with ``name``, ``minimum`` and ``maximum`` keys. - Each condition is a dict with ``name``, ``minimum`` and ``maximum`` keys.
@ -861,7 +861,7 @@ Example
Attributes Attributes
---------- ----------
- ``name``: required, string. A unique name that can be used to - ``name``: optional, string. A unique name that can be used to
identify this rule if it needs to be referenced elsewhere. identify this rule if it needs to be referenced elsewhere.
5.1.1 conditionset element 5.1.1 conditionset element