emacs-devel
[Top][All Lists]
Advanced

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

Re: Small docstring improvements


From: Philipp Stephani
Subject: Re: Small docstring improvements
Date: Sat, 20 Aug 2016 15:59:54 +0000



Eli Zaretskii <address@hidden> schrieb am Sa., 20. Aug. 2016 um 17:34 Uhr:
>  > +This does not take narrowing into account; to count the number of
>  > +characters in the accessible portion of the buffer, use
>  > +‘(- (point-max) (point-min))’. */)
>
>  The advice in the last sentence doesn't work when BUFFER is non-nil.
>  (I actually doubt that the advice is needed here; it's enough to have
>  something like that in the ELisp manual -- which already hints on
>  that, but maybe we should make that more explicit.
>
> I'd prefer a bit of redundancy in a very basic function such as this. At least I wouldn't want to search the Elisp
> manual for additional information unless really necessary. I'd reword it to "the accessible portion of the current
> buffer".

If we want to give advice like that, IMO we should also give such an
advice for when BUFFER is non-nil.

OK, then I'd append ", and to count the number of characters
in some other BUFFER, use
`(with-current-buffer BUFFER (- (point-max) (point-min)))'.". 

reply via email to

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