emacs-devel
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

Re: Community improvements to the Emacs Widget Library manual?


From: Mauro Aranda
Subject: Re: Community improvements to the Emacs Widget Library manual?
Date: Sun, 9 Jul 2023 09:02:38 -0300
User-agent: Mozilla/5.0 (X11; Linux x86_64; rv:102.0) Gecko/20100101 Thunderbird/102.11.0

Eli Zaretskii <eliz@gnu.org> writes:

>> Date: Sat, 8 Jul 2023 14:18:21 -0600
>> From: Bryce Carson <bovine@cyberscientist.ca>
>>
>> Would anyone like to collaborate to improve The Emacs Widget Library
>> manual? Are there any active
>> Emacs Lisp hackers that actually understand this library at a deep level?
>
> I think Mauro (CC'ed) is our widget expert.

Thank you for CCing me, Eli, although I'm pretty sure I'm far from an
expert.

>> The Emacs Widget Library manual could use a re-write, preferably
>> following the Diataxis
>> documentation framework if possible. Does anyone want to collaborate
>> over the long-term, creating a
>> study group and editing the manual to a high standard to benefit the
>> community and ourselves?
>
> I don't think I understand the plan in this aspect.  If important
> information is missing from the manual, it can and should be added.
> If you want to add tutorial-style sections, that could also be a good
> idea, provided that the subject is so complex that reading the main
> description is too hard without first reading a tutorial introduction.

I think the manual lacks more information about how to do more
"advanced" stuff.  It's not hard, but I feel like some ideas about
what one can do with widgets only pop up after reading the code. Which
of course is really useful, but the manual could do a better job so it
isn't as required as of now.

That would fall in the category of adding tutorial-style sections, I
think.  I'd love to help with that, but I don't have much time available
to do it on my own.




reply via email to

[Prev in Thread] Current Thread [Next in Thread]