emacs-devel
[Top][All Lists]
Advanced

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

Re: Gather a list of confusions beginner tend to have


From: Andreas Röhler
Subject: Re: Gather a list of confusions beginner tend to have
Date: Tue, 15 Sep 2020 12:13:27 +0200
User-agent: Mozilla/5.0 (X11; Linux i686; rv:68.0) Gecko/20100101 Thunderbird/68.9.0


On 15.09.20 10:21, Robert Pluim wrote:
On Tue, 15 Sep 2020 09:11:34 +0200, Andreas Röhler <andreas.roehler@online.de> 
said:
     Andreas> On 08.09.20 19:28, Yuan Fu wrote:


     Andreas> Hi,

     Andreas> thanks bringing up that matter.

     Andreas> When deciding to start with Emacs the faculty to extend was key.

     Andreas> A difficulty I'm still facing from time to time is the missing
     Andreas> type-info in function documentation strings. Need to know the 
type of
     Andreas> arguments and also the return-type.

Is this something missing in Emacs, or is it that some documentation
strings donʼt tell you this? If the latter, point them out and we'll
try to fix them.

Robert


Well, it happens from time to time... Let's search for some example though:

in ange-ftp.el

defun ange-ftp-dired-compress-file (name)

it's not told if "name" should be delivered as string are just a (quoted?) symbol.

defun ange-ftp-load (file &optional noerror nomessage nosuffix)

Assume the optional args must be boolean,  but not hint so far.


If you grep for "&rest args", should appear some stuff where it's not told what kind of args are expected.

For example in widget.el

(defun define-widget (name class doc &rest args)

Thanks developing Emacs,

Andreas




reply via email to

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