all messages for Emacs-related lists mirrored at yhetil.org
 help / color / mirror / code / Atom feed
From: Juanma Barranquero <lekktu@gmail.com>
To: Deniz Dogan <deniz.a.m.dogan@gmail.com>
Cc: 6493@debbugs.gnu.org
Subject: bug#6493:
Date: Fri, 23 Jul 2010 11:30:47 +0200	[thread overview]
Message-ID: <AANLkTimG7ODS1zvg2+0BGB8SYKox7QUwxy=OyHYQhiWV@mail.gmail.com> (raw)
In-Reply-To: <AANLkTim=rqKW-7v5e4b4RrL7yCFFF+nsc=rStd_mxbJJ@mail.gmail.com>

On Fri, Jul 23, 2010 at 11:10, Deniz Dogan <deniz.a.m.dogan@gmail.com> wrote:

> Attached is a new patch.

Thanks.

Three comments:

 - You changed "Return" to "Returns", but it is standard Emacs
practice to make the first line in a docstring imperative. From
(elisp) D.6 "Tips for Documentation Strings":

  For consistency, phrase the verb in the first sentence of a
  function's documentation string as an imperative--for instance,
  use "Return the cons of A and B." in preference to "Returns the
  cons of A and B."

- You didn't write ChangeLog entries. They are trivial in this case
(so no need to resend), but usually a patch should include them.

- This thead has been just Drew and you, and I'm not sure the result
is better. Though I understand Drew's arguments, it is still a bit
weird to me to look at the docstring of region-(beginning|end) and not
to see *any* reference to the region (yes, I know it is implicit in
"point or mark"). So I'd like to hear more opinions.

    Juanma


=== modified file 'src/editfns.c'
--- src/editfns.c	2010-06-16 20:08:41 +0000
+++ src/editfns.c	2010-06-27 12:22:00 +0000
@@ -349,14 +349,18 @@
 }

 DEFUN ("region-beginning", Fregion_beginning, Sregion_beginning, 0, 0, 0,
-       doc: /* Return position of beginning of region, as an integer.  */)
+       doc: /* Returns the smaller of point or mark, as a nonnegative integer.
+
+Raises an error if the mark is not set.  */)
      ()
 {
   return region_limit (1);
 }

 DEFUN ("region-end", Fregion_end, Sregion_end, 0, 0, 0,
-       doc: /* Return position of end of region, as an integer.  */)
+       doc: /* Returns the larger of point or mark, as a nonnegative integer.
+
+Raises an error if the mark is not set.  */)
      ()
 {
   return region_limit (0);





  reply	other threads:[~2010-07-23  9:30 UTC|newest]

Thread overview: 26+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2010-06-22 16:13 bug#6493: 24.0.50; doc strings of region-beginning, region-end Drew Adams
2010-06-27 12:26 ` bug#6493: Deniz Dogan
2010-06-27 13:52   ` bug#6493: Drew Adams
2010-06-27 14:02     ` bug#6493: Deniz Dogan
2010-06-27 14:18       ` bug#6493: Drew Adams
2010-06-27 14:29         ` bug#6493: Deniz Dogan
2010-06-27 14:33           ` bug#6493: Drew Adams
2010-07-10 23:41             ` bug#6493: Deniz Dogan
2010-07-11  4:20               ` bug#6493: Drew Adams
2010-07-23  0:12                 ` bug#6493: Juanma Barranquero
2010-07-23  9:10                   ` bug#6493: Deniz Dogan
2010-07-23  9:30                     ` Juanma Barranquero [this message]
2010-07-23 15:45                       ` bug#6493: Chong Yidong
2010-07-23 16:16                         ` bug#6493: Drew Adams
2010-07-23 17:02                         ` bug#6493: Stephen Berman
2010-07-23 17:26                           ` bug#6493: Drew Adams
2010-07-23 17:32                             ` bug#6493: Juanma Barranquero
2010-07-29 11:44                               ` bug#6493: Juanma Barranquero
2010-07-29 15:16                                 ` bug#6493: Johan Bockgård
2010-08-01 19:01                                   ` bug#6493: Juanma Barranquero
2010-08-01 21:17                                     ` bug#6493: Drew Adams
2010-08-02  3:30                                       ` bug#6493: Juanma Barranquero
2010-08-02  5:09                                         ` bug#6493: Drew Adams
2010-08-02  5:34                                         ` bug#6493: Drew Adams
2010-08-02  6:43                                           ` bug#6493: Juanma Barranquero
2010-07-29 15:58                                 ` bug#6493: Chong Yidong

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

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to='AANLkTimG7ODS1zvg2+0BGB8SYKox7QUwxy=OyHYQhiWV@mail.gmail.com' \
    --to=lekktu@gmail.com \
    --cc=6493@debbugs.gnu.org \
    --cc=deniz.a.m.dogan@gmail.com \
    /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 external index

	https://git.savannah.gnu.org/cgit/emacs.git
	https://git.savannah.gnu.org/cgit/emacs/org-mode.git

This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.