(Fface_attribute_relative_p): Doc fix.
authorRichard M. Stallman <rms@gnu.org>
Mon, 3 Jul 2006 15:42:10 +0000 (15:42 +0000)
committerRichard M. Stallman <rms@gnu.org>
Mon, 3 Jul 2006 15:42:10 +0000 (15:42 +0000)
src/xfaces.c

index df303e4..30e1c7a 100644 (file)
@@ -4799,7 +4799,14 @@ x_update_menu_appearance (f)
 DEFUN ("face-attribute-relative-p", Fface_attribute_relative_p,
        Sface_attribute_relative_p,
        2, 2, 0,
-       doc: /* Return non-nil if face ATTRIBUTE VALUE is relative.  */)
+       doc: /* Check whether a face attribute value is relative.
+Specifically, this function returns t if the attribute ATTRIBUTE
+with the value VALUE is relative.
+
+A relative value is one that doesn't entirely override whatever is
+inherited from another face.  For most possible attributes,
+the only relative value that users see is `unspecified'.
+However, for :height, floating point values are also relative.  */)
      (attribute, value)
      Lisp_Object attribute, value;
 {