Clarify user expectations for getStatNames

Closes #2890
fonttools · Nov 16, 2022 · 7c83736 · 7c83736
1 parent 8e9bf42
commit 7c83736
Showing 1 changed file with 7 additions and 3 deletions.
diff --git a/Lib/fontTools/designspaceLib/statNames.py b/Lib/fontTools/designspaceLib/statNames.py
@@ -56,9 +56,13 @@ def getStatNames(
 
     Also computes localizations.
 
-    If not enough STAT data is available for a given name, either its dict of
-    localized names will be empty (family and style names), or the name will be
-    None (PostScript name).
+    If not enough STAT data is available for a given name, either its dict of 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
     """