Note new excluded glyphs in API

xtermjs · Mar 15, 2024 · 6b3d485 · 6b3d485
1 parent 48c6e96
commit 6b3d485
Show file tree

Hide file tree

Showing 2 changed files with 16 additions and 4 deletions.
diff --git a/typings/xterm-headless.d.ts b/typings/xterm-headless.d.ts
@@ -144,8 +144,14 @@ declare module '@xterm/headless' {
      * Whether to rescale glyphs horizontally that are a single cell wide but
      * have glyphs that would overlap following cell(s). This typically happens
      * for ambiguous width characters (eg. the roman numeral characters U+2160+)
-     * which aren't featured in monospace fonts. Emoji glyphs are never
-     * rescaled. This is an important feature for achieving GB18030 compliance.
+     * which aren't featured in monospace fonts. This is an important feature
+     * for achieving GB18030 compliance.
+     *
+     * The following glyphs will never be rescaled:
+     *
+     * - Emoji glyphs
+     * - Powerline glyphs
+     * - Nerd font glyphs
      *
      * Note that this doesn't work with the DOM renderer. The default is false.
      */

diff --git a/typings/xterm.d.ts b/typings/xterm.d.ts
@@ -213,8 +213,14 @@ declare module '@xterm/xterm' {
      * Whether to rescale glyphs horizontally that are a single cell wide but
      * have glyphs that would overlap following cell(s). This typically happens
      * for ambiguous width characters (eg. the roman numeral characters U+2160+)
-     * which aren't featured in monospace fonts. Emoji glyphs are never
-     * rescaled. This is an important feature for achieving GB18030 compliance.
+     * which aren't featured in monospace fonts. This is an important feature
+     * for achieving GB18030 compliance.
+     *
+     * The following glyphs will never be rescaled:
+     *
+     * - Emoji glyphs
+     * - Powerline glyphs
+     * - Nerd font glyphs
      *
      * Note that this doesn't work with the DOM renderer. The default is false.
      */