From ccffce58cc5bcb07d82b2085a3ebb42ea04b2579 Mon Sep 17 00:00:00 2001
From: Behdad Esfahbod <behdad@behdad.org>
Date: Tue, 10 Jan 2023 13:09:30 -0700
Subject: [PATCH] [scale] More docs

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

diff --git a/src/hb-font.cc b/src/hb-font.cc
index 93510a1fd..bbcf54ed5 100644
--- a/src/hb-font.cc
+++ b/src/hb-font.cc
@@ -2283,7 +2283,17 @@ hb_font_set_funcs_data (hb_font_t         *font,
  * types and you need to leave room for fractional values
  * in there.
  *
- * The choice is yours but needs to be consistent between
+ * For example, to set the font size to 20, with 64
+ * levels of fractional precision you would call
+ * `hb_font_set_scale(font, 20 * 64, 20 * 64)`.
+ *
+ * In the example above, even what font size 20 means is up to
+ * you. It might be 20 pixels, or 20 points, or 20 millimeters.
+ * HarfBuzz does not care about that.  You can set the point
+ * size of the font using hb_font_set_ptem(), and the pixel
+ * size using hb_font_set_ppem().
+ *
+ * The choice of scale 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.
  *