On 01/24/11 04:56 AM, walter harms wrote:
>
>
> Am 23.01.2011 18:26, schrieb Alan Coopersmith:
>>> @@ -134,7 +138,36 @@ Specifies the widget.
>>> .SH DESCRIPTION
>>> .ZN XtName
>>> returns the widget's name.
>>> +
>>> +.SH EXAMPLE
>>> +
>>> +The example demonstrate the use.
>>
>> I'd just leave that line out, since it's obvious that's what the
>> example is for - putting in something more descriptive is useful,
>> but stating the obvious doesn't seem to be. (Also, I'd have
>> written it as "This example demonstrates the use of XtName."
>> but that also doesn't add anything, so just removing seems best.)
>>
>
> Whats about:
> "The example will print the name of the label widget to stdout."
>
> The idea is to explain what the user can expect. (Did not work in
> the first version also).
That sounds fine.
--
-Alan Coopersmith- [email protected]
Oracle Solaris Platform Engineering: X Window System
_______________________________________________
[email protected]: X.Org development
Archives: http://lists.x.org/archives/xorg-devel
Info: http://lists.x.org/mailman/listinfo/xorg-devel
