From: Eli Zaretskii <eliz@gnu.org>
Date: Sun, 8 Aug 2010 16:43:26 +0000 (+0300)
Subject: Make some doc strings bidi-friendly.
X-Git-Tag: emacs-pretest-24.0.90~104^2~275^2~438^2~49^2~18
X-Git-Url: http://git.eshelyaron.com/gitweb/?a=commitdiff_plain;h=cd21226da41a652bbf21557307bf7e4904fa1524;p=emacs.git

Make some doc strings bidi-friendly.

 cmds.c (Fforward_line, Fbeginning_of_line, Fend_of_line):
 editfns.c (Fline_beginning_position, Fline_end_position): State
 in the doc strings that start and end of line are in the logical order.
---

diff --git a/src/ChangeLog b/src/ChangeLog
index c3dfd6859c0..551ab9d215a 100644
--- a/src/ChangeLog
+++ b/src/ChangeLog
@@ -1,5 +1,10 @@
 2010-08-08  Eli Zaretskii  <eliz@gnu.org>
 
+	* cmds.c (Fforward_line, Fbeginning_of_line, Fend_of_line):
+	* editfns.c (Fline_beginning_position, Fline_end_position): State
+	in the doc strings that start and end of line are in the logical
+	order.
+
 	* xdisp.c (display_line): Move the handling of overlay arrow after
 	the call to find_row_edges.  (Bug#6699)
 
diff --git a/src/cmds.c b/src/cmds.c
index 7d54f46aeb4..4cb6ca199e7 100644
--- a/src/cmds.c
+++ b/src/cmds.c
@@ -113,7 +113,8 @@ right or to the left on the screen.  This is in contrast with
 
 DEFUN ("forward-line", Fforward_line, Sforward_line, 0, 1, "^p",
        doc: /* Move N lines forward (backward if N is negative).
-Precisely, if point is on line I, move to the start of line I + N.
+Precisely, if point is on line I, move to the start of line I + N
+\("start of line" in the logical order).
 If there isn't room, go as far as possible (no error).
 Returns the count of lines left to move.  If moving forward,
 that is N - number of lines moved; if backward, N + number moved.
@@ -157,7 +158,7 @@ successfully moved (for the return value).  */)
 }
 
 DEFUN ("beginning-of-line", Fbeginning_of_line, Sbeginning_of_line, 0, 1, "^p",
-       doc: /* Move point to beginning of current line.
+       doc: /* Move point to beginning of current line (in the logical order).
 With argument N not nil or 1, move forward N - 1 lines first.
 If point reaches the beginning or end of buffer, it stops there.
 
@@ -181,7 +182,7 @@ instead.  For instance, `(forward-line 0)' does the same thing as
 }
 
 DEFUN ("end-of-line", Fend_of_line, Send_of_line, 0, 1, "^p",
-       doc: /* Move point to end of current line.
+       doc: /* Move point to end of current line (in the logical order).
 With argument N not nil or 1, move forward N - 1 lines first.
 If point reaches the beginning or end of buffer, it stops there.
 To ignore intangibility, bind `inhibit-point-motion-hooks' to t.
diff --git a/src/editfns.c b/src/editfns.c
index c3ffd203124..0e034cc76fd 100644
--- a/src/editfns.c
+++ b/src/editfns.c
@@ -805,6 +805,9 @@ DEFUN ("line-beginning-position",
 With argument N not nil or 1, move forward N - 1 lines first.
 If scan reaches end of buffer, return that position.
 
+The returned position is of the first character in the logical order,
+i.e. the one that has the smallest character position.
+
 This function constrains the returned position to the current field
 unless that would be on a different line than the original,
 unconstrained result.  If N is nil or 1, and a front-sticky field
@@ -843,6 +846,9 @@ DEFUN ("line-end-position", Fline_end_position, Sline_end_position, 0, 1, 0,
 With argument N not nil or 1, move forward N - 1 lines first.
 If scan reaches end of buffer, return that position.
 
+The returned position is of the last character in the logical order,
+i.e. the character whose buffer position is the largest one.
+
 This function constrains the returned position to the current field
 unless that would be on a different line than the original,
 unconstrained result.  If N is nil or 1, and a rear-sticky field ends