help-gnu-emacs
[Top][All Lists]
Advanced

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

Re: Improving language in documentation of assoc


From: Pierre Rouleau
Subject: Re: Improving language in documentation of assoc
Date: Wed, 5 Feb 2025 14:30:02 -0500

The proposal:

> Replace:
> >
> > Return non-nil if KEY is equal to the car of an element of ALIST.
> > The value is actually the first element of ALIST whose car equals KEY.
> >
> > with:
> >
> > Retrieve first cons of ALIST whose car equals KEY; else return NIL.
> >
>

... would have been nice to see right at the top of your original email.
It is a valid and even more concise description.

Inside it I would only replace 'NIL' by 'nil',
as uppercase is usually identifying arguments, to get:

     Retrieve first cons of ALIST whose car equals KEY; else return nil.


BTW, to search the entire set of loaded function docstrings,
you can use:`apropos-documentation PATTERN DO-ALL` (with 'C-u C-h d' ).
To look for NIL in all docstrings: C-u C-h d NIL RET
Then turn off case folding and search for NIL.

-- 
/Pierre


reply via email to

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