Commit abd997aa7cf2bc9219136782c7363d14d325199c

Werner Lemberg 2018-09-21T12:50:32

Improve documentation of `FT_LOAD_NO_RECURSE'.

diff --git a/include/freetype/freetype.h b/include/freetype/freetype.h
index 25db584..dc637f8 100644
--- a/include/freetype/freetype.h
+++ b/include/freetype/freetype.h
@@ -2929,10 +2929,13 @@ FT_BEGIN_HEADER
    *
    *   FT_LOAD_NO_RECURSE ::
    *     Don't load composite glyphs recursively.  Instead, the font driver
-   *     should set the `num_subglyph` and `subglyphs` values of the glyph
-   *     slot accordingly, and set `glyph->format` to
-   *     @FT_GLYPH_FORMAT_COMPOSITE.  The description of subglyphs can then
-   *     be accessed with @FT_Get_SubGlyph_Info.
+   *     fills the `num_subglyph` and `subglyphs` values of the glyph slot;
+   *     it also sets `glyph->format` to @FT_GLYPH_FORMAT_COMPOSITE.  The
+   *     description of subglyphs can then be accessed with
+   *     @FT_Get_SubGlyph_Info.
+   *
+   *     Don't use this flag for retrieving metrics information since some
+   *     font drivers only return rudimentary data.
    *
    *     This flag implies @FT_LOAD_NO_SCALE and @FT_LOAD_IGNORE_TRANSFORM.
    *