Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Clarify user expectations for getStatNames #2892

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
12 changes: 6 additions & 6 deletions Doc/source/designspaceLib/xml.rst
Expand Up @@ -814,12 +814,12 @@ The ``<instances>`` element contains one or more ``<instance>`` elements.

.. rubric:: Attributes

- ``familyname``: required, string. The family name of the instance
font. Corresponds with ``font.info.familyName``
- ``stylename``: required, string. The style name of the instance font.
Corresponds with ``font.info.styleName``
- ``name``: required, string. A unique name that can be used to
identify this font if it needs to be referenced elsewhere.
- ``familyname``: string. Optional if the default source has it set. The family
name of the instance font. Corresponds with ``font.info.familyName``
- ``stylename``: string. Optional if all axes are fully labled. The style name
of the instance font. Corresponds with ``font.info.styleName``
- ``name``: string. Optional if all axes are fully labled. A unique name that
can be used to identify this font if it needs to be referenced elsewhere.
- ``filename``: string. Required for MutatorMath. A path to the
instance file, relative to the root path of this document. The path
can be at the same level as the document or lower.
Expand Down
4 changes: 4 additions & 0 deletions Lib/fontTools/designspaceLib/statNames.py
Expand Up @@ -60,6 +60,10 @@ def getStatNames(
localized names will be empty (family and style names), or the name will be
None (PostScript name).

Note: this method does not consider info attached to the instance, like
family name. The user needs to override all names on an instance that STAT
information would compute differently than desired.

.. versionadded:: 5.0
"""
familyNames: Dict[str, str] = {}
Expand Down