From 8c47580ac85b3eed0b932d50236d589e8c8747cf Mon Sep 17 00:00:00 2001
From: Behdad Esfahbod <behdad@behdad.org>
Date: Tue, 10 Jan 2023 12:53:54 -0700
Subject: [PATCH] [scale] Document

---
 src/hb-font.cc | 12 ++++++++++++
 1 file changed, 12 insertions(+)

diff --git a/src/hb-font.cc b/src/hb-font.cc
index 28d3a4b2c..8783e0a8c 100644
--- a/src/hb-font.cc
+++ b/src/hb-font.cc
@@ -2275,6 +2275,18 @@ hb_font_set_funcs_data (hb_font_t         *font,
  *
  * Sets the horizontal and vertical scale of a font.
  *
+ * The font scale is a number related to, but not the same as,
+ * font size. Typically the client establishes a scale factor
+ * to be used between the two. For example, 64, or 256, which
+ * would be the fractional-precision part of the font scale.
+ * This is necessary because #hb_position_t values are integer
+ * types and you need to leave room for fractional values
+ * in there.
+ *
+ * The choice is yours but needs to be consistent between
+ * what you set here, and what you expect out of #hb_position_t
+ * as well has draw / paint API output values.
+ *
  * Since: 0.9.2
  **/
 void