Re: [R21.4] [COMMIT] Update glyph documentation
"Stephen J. Turnbull" <stephen(a)xemacs.org> writes:
>>>>> "Ben" == Ben Wing <ben(a)666.com>
writes:
>> Yeah, I noticed that. I've been planning to take a look at
>> this.
Ben> `make-glyph' returns a glyph object, and to me, the docs do
Ben> say that:
Ben> "Create a new glyph of type TYPE.
To me they don't. It is a reasonable guess at best. For example, the
doc string for make-directory says:
Create the directory DIR and any nonexistent parent dirs.
But that does not mean (at least to me) that the directory DIR and any
nonexisting parent dirs are then returned by the function.
I would write something like this:
"Return a new glyph object, which describes a single display element.
A glyph object contains an image specification and several other
display properties. See [the relevant accessors and mutators, with
mention of the type of each property].
This sounds reasonable.
--
David Kastrup, Kriemhildstr. 15, 44793 Bochum