[pango/simple-fontmap: 4/22] font: Documentation additions and clarifications

[Matthias Clasen <matthiasc src gnome org>]

commit 1adb9af44ce24f5e82be1924e3ecde11f0b4dab1
Author: Matthias Clasen <mclasen redhat com>
Date:   Wed Dec 29 13:54:47 2021 -0500

    font: Documentation additions and clarifications
    
    Face names are not actually guaranteed to be unique,
    so don't say that.

 pango/fonts.c | 12 +++++++++---
 1 file changed, 9 insertions(+), 3 deletions(-)
---
diff --git a/pango/fonts.c b/pango/fonts.c
index 3fbd43ad..f1bf7cea 100644
--- a/pango/fonts.c
+++ b/pango/fonts.c
@@ -2427,6 +2427,12 @@ pango_font_family_get_name (PangoFontFamily  *family)
  *
  * The faces in a family share a common design, but differ in slant, weight,
  * width and other aspects.
+ *
+ * Note that the returned faces are not in any particular order, and
+ * multiple faces may have the same name or characteristics.
+ *
+ * `PangoFontFamily` also implemented the [iface@Gio.ListModel] interface
+ * for enumerating faces.
  */
 void
 pango_font_family_list_faces (PangoFontFamily  *family,
@@ -2642,9 +2648,9 @@ pango_font_face_is_synthesized (PangoFontFace  *face)
  *
  * Gets a name representing the style of this face.
  *
- * The name identifies the face among the different faces
- * in the `PangoFontFamily` for the face. It is suitable
- * for displaying to users.
+ * Note that a font family may contain multiple faces
+ * with the same name (e.g. a variable and a non-variable
+ * face for the same style).
  *
  * Return value: the face name for the face. This string is
  *   owned by the face object and must not be modified or freed.