GNU bug report logs - #18478
24.4.50; doc string of `clone-indirect-buffer'

Previous Next

Full log

Message #14 received at 18478 <at> debbugs.gnu.org (full text, mbox):

From: Tom Willemse <tom <at> ryuslash.org>
To: Drew Adams <drew.adams <at> oracle.com>
Cc: 18478 <at> debbugs.gnu.org
Subject: Re: [Patch] Mention the return value of `clone-indirect-buffer'
Date: Thu, 18 Sep 2014 01:11:37 +0200

Hey Drew,

Drew Adams <drew.adams <at> oracle.com> writes:

>> I've attached a suggestion for mentioning the return value for
>> `clone-indirect-buffer'. Please let me know what you think.
>
> Looks OK to me.  You can also simplify it to just "Returns...".

Certainly, if that has your preference. I just thought that because it
is a new paragraph and the ones before it talk about the meanings of the
arguments it would be clearer to explicitly state it's about the
function.

I actually would have liked to start the docstring off with "Create and
return ..." as the docstring for `clone-buffer' does, but checkdoc then
started complaining about the line being more than 80 characters long.

Previous Next

GNU bug tracking system
Copyright (C) 1999 Darren O. Benham, 1997,2003 nCipher Corporation Ltd, 1994-97 Ian Jackson.