Re: Gather a list of confusions beginner tend to have

[Robert Pluim]

>>>>> On Tue, 15 Sep 2020 12:13:27 +0200, Andreas Röhler 
>>>>> <andreas.roehler@online.de> said:
    >> 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


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

    Andreas> in ange-ftp.el

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

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

I think emacs always uses strings when naming files.

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

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

Hmm yes, but I think thatʼs an internal function, so not too
surprising.

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

    Andreas> For example in widget.el

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

Are here it depends very much on which widget youʼre using, so itʼs
hard to specify in the docstring.

Robert