Clarify user expectations for getStatNames

Closes #2890
fonttools · Nov 16, 2022 · 820ba9d · 820ba9d
1 parent 8e9bf42
commit 820ba9d
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/Lib/fontTools/designspaceLib/statNames.py b/Lib/fontTools/designspaceLib/statNames.py
@@ -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] = {}