Skip to content

Commit 538d852

Browse files
committed
docs(config): describe fallback migration directly
The migration docstring narrated the former key design instead of explaining the live compatibility path. State what each spelling stores, which value wins, and when compatibility spellings are removed. Verified with both full suites, the strict prose checks, and diff checks.
1 parent 3f7ec86 commit 538d852

1 file changed

Lines changed: 4 additions & 5 deletions

File tree

src/crossglyph/fontconf.py

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -861,12 +861,11 @@ def _space_widths(values: dict[str, str], where: str) -> dict[int, float]:
861861

862862
def _migrate_legacy_fallbacks(path: pathlib.Path,
863863
values: dict[str, str]) -> dict[str, str]:
864-
"""Rename the two family fallback keys in place, once.
864+
"""Replace compatibility spellings with the family fallback keys.
865865
866-
The config used to name the regular source file that identifies each
867-
fallback family. The build has always resolved the rest of that family
868-
from the file. Keep a new key when both spellings are present, and remove
869-
the stale spelling either way.
866+
Both spellings store the regular source file that identifies a fallback
867+
family. Keep the current key when both are present, and remove each
868+
compatibility spelling after reading it.
870869
"""
871870
migrated = dict(values)
872871
changes: dict[str, str | None] = {}

0 commit comments

Comments
 (0)