[Emacs-diffs] trunk r116911: * lisp/simple.el (cycle-spacing--context, cycle-spacing): Doc tweaks.

[Glenn Morris]

------------------------------------------------------------
revno: 116911
revision-id: address@hidden
parent: address@hidden
committer: Glenn Morris <address@hidden>
branch nick: trunk
timestamp: Sun 2014-03-30 17:35:12 -0700
message:
  * lisp/simple.el (cycle-spacing--context, cycle-spacing): Doc tweaks.
  
  Include restoring manual line-breaks to state before r116897.
modified:
  lisp/ChangeLog                 changelog-20091113204419-o5vbwnq5f7feedwu-1432
  lisp/simple.el                 simple.el-20091113204419-o5vbwnq5f7feedwu-403

=== modified file 'lisp/ChangeLog'
--- a/lisp/ChangeLog    2014-03-31 00:22:29 +0000
+++ b/lisp/ChangeLog    2014-03-31 00:35:12 +0000
@@ -1,3 +1,7 @@
+2014-03-31  Glenn Morris  <address@hidden>
+
+       * simple.el (cycle-spacing--context, cycle-spacing): Doc tweaks.
+
 2014-03-31  Reto Zimmermann  <address@hidden>
 
        Sync with upstream vhdl mode v3.35.2.
@@ -52,11 +56,11 @@
 
        * simple.el (cycle-spacing): Never delete spaces on first run by
        default, but do so in a new 'fast mode and if there are already
-       N spaces (the previous behaviour).
+       N spaces (the previous behavior).
        Compare N with its value in previous invocation so that changing
        prefix argument restarts `cycle-spacing' sequence.
        The idea is that with this change, binding M-SPC to
-       `cycle-spacing' should not introduce any changes in behaviour of
+       `cycle-spacing' should not introduce any changes in behavior of
        the binding so long as users do not type M-SPC twice in a raw with
        the same prefix argument or lack thereof.
 

=== modified file 'lisp/simple.el'
--- a/lisp/simple.el    2014-03-30 19:12:57 +0000
+++ b/lisp/simple.el    2014-03-31 00:35:12 +0000
@@ -805,33 +805,32 @@
 
 (defvar cycle-spacing--context nil
   "Store context used in consecutive calls to `cycle-spacing' command.
-The first time this function is run, it saves N argument, the
-original point position and original spacing around the point in
-this variable.")
+The first time `cycle-spacing' runs, it saves in this variable:
+its N argument, the original point position, and the original spacing
+around point.")
 
 (defun cycle-spacing (&optional n preserve-nl-back mode)
   "Manipulate whitespace around point in a smart way.
-In interactive use, this function behaves differently in
-successive consecutive calls.
+In interactive use, this function behaves differently in successive
+consecutive calls.
 
-The first call in a sequence acts like `just-one-space'.  It
-deletes all spaces and tabs around point, leaving one space \(or
-N spaces).  N is the prefix argument.  If N is negative, it
-deletes newlines as well leaving -N spaces.  (If PRESERVE-NL-BACK
-is non-nil, it does not delete newlines before point.)
+The first call in a sequence acts like `just-one-space'.
+It deletes all spaces and tabs around point, leaving one space
+\(or N spaces).  N is the prefix argument.  If N is negative,
+it deletes newlines as well, leaving -N spaces.
+\(If PRESERVE-NL-BACK is non-nil, it does not delete newlines before point.)
 
 The second call in a sequence deletes all spaces.
 
-The third call in a sequence restores the original
-whitespace (and point).
-
-If MODE is 'single-shot only the first step is performed.  If
-MODE is 'fast and the first step did not result in any
-change (i.e. there was exactly (abs N) spaces around point)
-function goes to the second step immediately.
-
-Running the function with different N arguments initiates a new
-sequence each time."
+The third call in a sequence restores the original whitespace (and point).
+
+If MODE is `single-shot', it only performs the first step in the sequence.
+If MODE is `fast' and the first step would not result in any change
+\(i.e., there are exactly (abs N) spaces around point),
+the function goes straight to the second step.
+
+Repeatedly calling the function with different values of N starts a
+new sequence each time."
   (interactive "*p")
   (let ((orig-pos       (point))
        (skip-characters (if (and n (< n 0)) " \t\n\r" " \t"))