[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
bug#6493:
From: |
Juanma Barranquero |
Subject: |
bug#6493: |
Date: |
Fri, 23 Jul 2010 11:30:47 +0200 |
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);
- bug#6493:, Deniz Dogan, 2010/07/10
- bug#6493:, Drew Adams, 2010/07/11
- bug#6493:, Juanma Barranquero, 2010/07/22
- bug#6493:, Deniz Dogan, 2010/07/23
- bug#6493:,
Juanma Barranquero <=
- bug#6493:, Chong Yidong, 2010/07/23
- bug#6493:, Drew Adams, 2010/07/23
- bug#6493:, Stephen Berman, 2010/07/23
- bug#6493:, Drew Adams, 2010/07/23
- bug#6493:, Juanma Barranquero, 2010/07/23
- bug#6493:, Juanma Barranquero, 2010/07/29
- bug#6493:, Johan Bockgård, 2010/07/29
- bug#6493:, Chong Yidong, 2010/07/29