From: Drew Adams <drew.adams@oracle.com>
To: Tom Willemse <tom@ryuslash.org>
Cc: 18478@debbugs.gnu.org
Subject: bug#18478: [Patch] Mention the return value of `clone-indirect-buffer'
Date: Wed, 17 Sep 2014 18:47:01 -0700 (PDT) [thread overview]
Message-ID: <4919c10d-ac35-475d-9b66-12deaa8d7fbe@default> (raw)
In-Reply-To: <m3oaudzvti.fsf@ryuslash.org>
> >> 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 have no preference. And my preference doesn't count for anything.
I just reported the bug.
> 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.
Yes, but I don't see any chance for confusion there. It is only
the function return value that matters. And arguments do not
"return". They are evaluated, of course, and their values are
returned by that evaluation. But we just speak of their "values".
> 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.
FWIW, I don't put a lot of stock in checkdoc, personally. ;-)
next prev parent reply other threads:[~2014-09-18 1:47 UTC|newest]
Thread overview: 9+ messages / expand[flat|nested] mbox.gz Atom feed top
2014-09-14 22:14 bug#18478: 24.4.50; doc string of `clone-indirect-buffer' Drew Adams
2014-09-17 22:49 ` bug#18478: [Patch] Mention the return value " Tom Willemse
2014-09-17 22:55 ` Drew Adams
2014-09-17 23:11 ` Tom Willemse
2014-09-18 1:47 ` Drew Adams [this message]
2014-09-18 2:40 ` Stefan Monnier
2014-09-18 4:05 ` Drew Adams
2014-09-20 23:50 ` Tom Willemse
2014-09-21 22:10 ` Stefan Monnier
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
List information: https://www.gnu.org/software/emacs/
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=4919c10d-ac35-475d-9b66-12deaa8d7fbe@default \
--to=drew.adams@oracle.com \
--cc=18478@debbugs.gnu.org \
--cc=tom@ryuslash.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
Code repositories for project(s) associated with this public inbox
https://git.savannah.gnu.org/cgit/emacs.git
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).