aboutsummaryrefslogtreecommitdiffstats
path: root/lisp
diff options
context:
space:
mode:
authorJuanma Barranquero2008-12-18 16:19:12 +0000
committerJuanma Barranquero2008-12-18 16:19:12 +0000
commite643842898ea3512d31bf05fd5171385376ca7bb (patch)
treec70ecb9834b4fa87b2df66d6da0cb2e464a372d1 /lisp
parent947c75968800fac67cc21c14f01f9c02c7d5b16b (diff)
downloademacs-e643842898ea3512d31bf05fd5171385376ca7bb.tar.gz
emacs-e643842898ea3512d31bf05fd5171385376ca7bb.zip
* textmodes/rst.el (rst-promote-region): Reflow docstring.
(rst-mode-map, rst-mode-hook, rst-section-tree-rec) (rst-repeat-last-character): Fix typos in docstrings. (rst-mode, rst-backward-section): Doc fixes.
Diffstat (limited to 'lisp')
-rw-r--r--lisp/ChangeLog7
-rw-r--r--lisp/textmodes/rst.el40
2 files changed, 27 insertions, 20 deletions
diff --git a/lisp/ChangeLog b/lisp/ChangeLog
index 3185940ce9a..a07cbbc5eb9 100644
--- a/lisp/ChangeLog
+++ b/lisp/ChangeLog
@@ -1,3 +1,10 @@
12008-12-18 Juanma Barranquero <lekktu@gmail.com>
2
3 * textmodes/rst.el (rst-promote-region): Reflow docstring.
4 (rst-mode-map, rst-mode-hook, rst-section-tree-rec)
5 (rst-repeat-last-character): Fix typos in docstrings.
6 (rst-mode, rst-backward-section): Doc fixes.
7
12008-12-18 Ulf Jasper <ulf.jasper@web.de> 82008-12-18 Ulf Jasper <ulf.jasper@web.de>
2 9
3 * net/newst-treeview.el (newsticker-groups-filename): Made obsolete. 10 * net/newst-treeview.el (newsticker-groups-filename): Made obsolete.
diff --git a/lisp/textmodes/rst.el b/lisp/textmodes/rst.el
index 7d0006a8ee5..a24ad023060 100644
--- a/lisp/textmodes/rst.el
+++ b/lisp/textmodes/rst.el
@@ -302,7 +302,7 @@
302 (define-key map [(control c) (?5)] 'rst-compile-slides-preview) 302 (define-key map [(control c) (?5)] 'rst-compile-slides-preview)
303 303
304 map) 304 map)
305 "Keymap for ReStructuredText mode commands. 305 "Keymap for reStructuredText mode commands.
306This inherits from Text mode.") 306This inherits from Text mode.")
307 307
308 308
@@ -344,8 +344,8 @@ This inherits from Text mode.")
344 344
345 345
346(defcustom rst-mode-hook nil 346(defcustom rst-mode-hook nil
347 "Hook run when Rst Mode is turned on. 347 "Hook run when Rst mode is turned on.
348The hook for Text Mode is run before this one." 348The hook for Text mode is run before this one."
349 :group 'rst 349 :group 'rst
350 :type '(hook)) 350 :type '(hook))
351 351
@@ -367,18 +367,19 @@ The value of this variable is used when Rst mode is turned on."
367;;;###autoload 367;;;###autoload
368(define-derived-mode rst-mode text-mode "ReST" 368(define-derived-mode rst-mode text-mode "ReST"
369 "Major mode for editing reStructuredText documents. 369 "Major mode for editing reStructuredText documents.
370 370\\<rst-mode-map>
371There are a number of convenient keybindings provided by 371There are a number of convenient keybindings provided by
372Rst mode. The main one is \\[rst-adjust\], it updates or rotates 372Rst mode. The main one is \\[rst-adjust], it updates or rotates
373the section title around point or promotes/demotes the 373the section title around point or promotes/demotes the
374decorations within the region (see full details below). 374decorations within the region (see full details below).
375Use negative prefix arg to rotate in the other direction. 375Use negative prefix arg to rotate in the other direction.
376\\{rst-mode-map}
377 376
378Turning on `rst-mode' calls the normal hooks `text-mode-hook' and 377Turning on `rst-mode' calls the normal hooks `text-mode-hook'
379`rst-mode-hook'. This mode also supports font-lock highlighting. 378and `rst-mode-hook'. This mode also supports font-lock
380You may customize `rst-mode-lazy' to toggle font-locking of 379highlighting. You may customize `rst-mode-lazy' to toggle
381blocks." 380font-locking of blocks.
381
382\\{rst-mode-map}"
382 :abbrev-table rst-mode-abbrev-table 383 :abbrev-table rst-mode-abbrev-table
383 :syntax-table rst-mode-syntax-table 384 :syntax-table rst-mode-syntax-table
384 :group 'rst 385 :group 'rst
@@ -1369,9 +1370,9 @@ of the right hand fingers and the binding is unused in `text-mode'."
1369(defun rst-promote-region (&optional demote) 1370(defun rst-promote-region (&optional demote)
1370 "Promote the section titles within the region. 1371 "Promote the section titles within the region.
1371 1372
1372With argument DEMOTE or a prefix argument, demote the 1373With argument DEMOTE or a prefix argument, demote the section
1373section titles instead. The algorithm used at the boundaries of 1374titles instead. The algorithm used at the boundaries of the
1374the hierarchy is similar to that used by `rst-adjust-decoration'." 1375hierarchy is similar to that used by `rst-adjust-decoration'."
1375 (interactive) 1376 (interactive)
1376 1377
1377 (let* ((demote (or current-prefix-arg demote)) 1378 (let* ((demote (or current-prefix-arg demote))
@@ -1643,10 +1644,10 @@ child. This has advantages later in processing the graph."
1643(defun rst-section-tree-rec (decos lev) 1644(defun rst-section-tree-rec (decos lev)
1644 "Recursive guts of the section tree construction. 1645 "Recursive guts of the section tree construction.
1645DECOS is a cons cell whose cdr is the remaining list of 1646DECOS is a cons cell whose cdr is the remaining list of
1646decorations, and we change it as we consume them. LEV is the 1647decorations, and we change it as we consume them. LEV is
1647current level of that node. This function returns a pair of the 1648the current level of that node. This function returns a
1648subtree that was built. This treats the decos list 1649pair of the subtree that was built. This treats the DECOS
1649destructively." 1650list destructively."
1650 1651
1651 (let ((ndeco (cadr decos)) 1652 (let ((ndeco (cadr decos))
1652 node 1653 node
@@ -2138,8 +2139,7 @@ backwards in the file (default is to use 1)."
2138 )) 2139 ))
2139 2140
2140(defun rst-backward-section () 2141(defun rst-backward-section ()
2141 "Like `rst-forward-section', except move back one title. 2142 "Like `rst-forward-section', except move back one title."
2142With a prefix argument, move backward by a page."
2143 (interactive) 2143 (interactive)
2144 (rst-forward-section -1)) 2144 (rst-forward-section -1))
2145 2145
@@ -3366,7 +3366,7 @@ This is useful for filling list item paragraphs."
3366;; For sections, better to use the specialized function above, but this can 3366;; For sections, better to use the specialized function above, but this can
3367;; be useful for creating separators. 3367;; be useful for creating separators.
3368(defun rst-repeat-last-character (&optional tofill) 3368(defun rst-repeat-last-character (&optional tofill)
3369 "Fills the current line up to the length of the preceding line (if not 3369 "Fill the current line up to the length of the preceding line (if not
3370empty), using the last character on the current line. If the preceding line is 3370empty), using the last character on the current line. If the preceding line is
3371empty, we use the `fill-column'. 3371empty, we use the `fill-column'.
3372 3372