diff options
| author | Juanma Barranquero | 2008-01-25 02:18:05 +0000 |
|---|---|---|
| committer | Juanma Barranquero | 2008-01-25 02:18:05 +0000 |
| commit | 75bcb912ca11e772c239f1bb9a35f41d2f2725c1 (patch) | |
| tree | b2785f9785cbf8a43d15e0317878ee382faf5bd5 | |
| parent | ef5e3601471f4796cd04a0881ae241e79abea730 (diff) | |
| download | emacs-75bcb912ca11e772c239f1bb9a35f41d2f2725c1.tar.gz emacs-75bcb912ca11e772c239f1bb9a35f41d2f2725c1.zip | |
(allout-prefix-data): Doc fix.
(allout-show-current-subtree): Reflow docstring.
(allout-use-mode-specific-leader, allout-use-hanging-indents,
produce-allout-mode-map, allout-overlay-interior-modification-handler,
allout-next-heading, allout-previous-heading, allout-rebullet-heading,
allout-rebullet-topic, allout-rebullet-topic-grunt, allout-kill-topic,
allout-copy-topic-as-kill, allout-listify-exposed, allout-process-exposed,
allout-encrypted-key-info, allout-update-passphrase-mnemonic-aids,
allout-next-topic-pending-encryption, allout-tests-globally-true):
Fix typos in docstrings.
| -rw-r--r-- | lisp/ChangeLog | 16 | ||||
| -rw-r--r-- | lisp/allout.el | 51 |
2 files changed, 41 insertions, 26 deletions
diff --git a/lisp/ChangeLog b/lisp/ChangeLog index a4c7feae80d..28b1f7dc905 100644 --- a/lisp/ChangeLog +++ b/lisp/ChangeLog | |||
| @@ -1,3 +1,17 @@ | |||
| 1 | 2008-01-25 Juanma Barranquero <lekktu@gmail.com> | ||
| 2 | |||
| 3 | * allout.el (allout-prefix-data): Doc fix. | ||
| 4 | (allout-show-current-subtree): Reflow docstring. | ||
| 5 | (allout-use-mode-specific-leader, allout-use-hanging-indents) | ||
| 6 | (produce-allout-mode-map, allout-overlay-interior-modification-handler) | ||
| 7 | (allout-next-heading, allout-previous-heading, allout-rebullet-heading) | ||
| 8 | (allout-rebullet-topic, allout-rebullet-topic-grunt, allout-kill-topic) | ||
| 9 | (allout-copy-topic-as-kill, allout-listify-exposed) | ||
| 10 | (allout-process-exposed, allout-encrypted-key-info) | ||
| 11 | (allout-update-passphrase-mnemonic-aids) | ||
| 12 | (allout-next-topic-pending-encryption) | ||
| 13 | (allout-tests-globally-true): Fix typos in docstrings. | ||
| 14 | |||
| 1 | 2008-01-24 Stefan Monnier <monnier@iro.umontreal.ca> | 15 | 2008-01-24 Stefan Monnier <monnier@iro.umontreal.ca> |
| 2 | 16 | ||
| 3 | * vc.el (vc-version-diff): Make sure we shrink the right window. | 17 | * vc.el (vc-version-diff): Make sure we shrink the right window. |
| @@ -29,7 +43,7 @@ | |||
| 29 | * progmodes/python.el: Quote all calls to "auxiliary skeleton"s to | 43 | * progmodes/python.el: Quote all calls to "auxiliary skeleton"s to |
| 30 | prevent infloops. | 44 | prevent infloops. |
| 31 | 45 | ||
| 32 | 2008-01-20 Martin Svenson <phromo@gmail.com> (tiny change) | 46 | 2008-01-20 Martin Svenson <phromo@gmail.com> (tiny change) |
| 33 | 47 | ||
| 34 | * progmodes/python.el (python-imports): Default to "None". | 48 | * progmodes/python.el (python-imports): Default to "None". |
| 35 | 49 | ||
diff --git a/lisp/allout.el b/lisp/allout.el index dbaef725c13..43642e6ee26 100644 --- a/lisp/allout.el +++ b/lisp/allout.el | |||
| @@ -395,7 +395,7 @@ comment-start strings that do not end in spaces are tripled in | |||
| 395 | the header-prefix, and an `_' underscore is tacked on the end, to | 395 | the header-prefix, and an `_' underscore is tacked on the end, to |
| 396 | distinguish them from regular comment strings. comment-start | 396 | distinguish them from regular comment strings. comment-start |
| 397 | strings that do end in spaces are not tripled, but an underscore | 397 | strings that do end in spaces are not tripled, but an underscore |
| 398 | is substituted for the space. [This presumes that the space is | 398 | is substituted for the space. [This presumes that the space is |
| 399 | for appearance, not comment syntax. You can use | 399 | for appearance, not comment syntax. You can use |
| 400 | `allout-mode-leaders' to override this behavior, when | 400 | `allout-mode-leaders' to override this behavior, when |
| 401 | undesired.]" | 401 | undesired.]" |
| @@ -747,7 +747,7 @@ else allout's special hanging-indent maintaining auto-fill function, | |||
| 747 | (defcustom allout-use-hanging-indents t | 747 | (defcustom allout-use-hanging-indents t |
| 748 | "*If non-nil, topic body text auto-indent defaults to indent of the header. | 748 | "*If non-nil, topic body text auto-indent defaults to indent of the header. |
| 749 | Ie, it is indented to be just past the header prefix. This is | 749 | Ie, it is indented to be just past the header prefix. This is |
| 750 | relevant mostly for use with indented-text-mode, or other situations | 750 | relevant mostly for use with `indented-text-mode', or other situations |
| 751 | where auto-fill occurs." | 751 | where auto-fill occurs." |
| 752 | :type 'boolean | 752 | :type 'boolean |
| 753 | :group 'allout) | 753 | :group 'allout) |
| @@ -1124,10 +1124,10 @@ Also refresh various data structures that hinge on the regexp." | |||
| 1124 | (defvar allout-mode-map nil "Keybindings for (allout) outline minor mode.") | 1124 | (defvar allout-mode-map nil "Keybindings for (allout) outline minor mode.") |
| 1125 | ;;;_ > produce-allout-mode-map (keymap-alist &optional base-map) | 1125 | ;;;_ > produce-allout-mode-map (keymap-alist &optional base-map) |
| 1126 | (defun produce-allout-mode-map (keymap-list &optional base-map) | 1126 | (defun produce-allout-mode-map (keymap-list &optional base-map) |
| 1127 | "Produce keymap for use as allout-mode-map, from KEYMAP-LIST. | 1127 | "Produce keymap for use as `allout-mode-map', from KEYMAP-LIST. |
| 1128 | 1128 | ||
| 1129 | Built on top of optional BASE-MAP, or empty sparse map if none specified. | 1129 | Built on top of optional BASE-MAP, or empty sparse map if none specified. |
| 1130 | See doc string for allout-keybindings-list for format of binding list." | 1130 | See doc string for `allout-keybindings-list' for format of binding list." |
| 1131 | (let ((map (or base-map (make-sparse-keymap))) | 1131 | (let ((map (or base-map (make-sparse-keymap))) |
| 1132 | (pref (list allout-command-prefix))) | 1132 | (pref (list allout-command-prefix))) |
| 1133 | (mapcar (function | 1133 | (mapcar (function |
| @@ -2140,10 +2140,10 @@ OPEN: A TOPIC that is not CLOSED, though its OFFSPRING or BODY may be." | |||
| 2140 | "Get confirmation before making arbitrary changes to invisible text. | 2140 | "Get confirmation before making arbitrary changes to invisible text. |
| 2141 | 2141 | ||
| 2142 | We expose the invisible text and ask for confirmation. Refusal or | 2142 | We expose the invisible text and ask for confirmation. Refusal or |
| 2143 | keyboard-quit abandons the changes, with keyboard-quit additionally | 2143 | `keyboard-quit' abandons the changes, with keyboard-quit additionally |
| 2144 | reclosing the opened text. | 2144 | reclosing the opened text. |
| 2145 | 2145 | ||
| 2146 | No confirmation is necessary when inhibit-read-only is set - eg, allout | 2146 | No confirmation is necessary when `inhibit-read-only' is set - eg, allout |
| 2147 | internal functions use this feature cohesively bunch changes." | 2147 | internal functions use this feature cohesively bunch changes." |
| 2148 | 2148 | ||
| 2149 | (when (and (not inhibit-read-only) (not after)) | 2149 | (when (and (not inhibit-read-only) (not after)) |
| @@ -2234,7 +2234,8 @@ function can also be used as an `isearch-mode-end-hook'." | |||
| 2234 | (defsubst allout-prefix-data () | 2234 | (defsubst allout-prefix-data () |
| 2235 | "Register allout-prefix state data. | 2235 | "Register allout-prefix state data. |
| 2236 | 2236 | ||
| 2237 | For reference by `allout-recent' funcs. Returns BEGINNING." | 2237 | For reference by `allout-recent' funcs. Return |
| 2238 | the new value of `allout-recent-prefix-beginning'." | ||
| 2238 | (setq allout-recent-prefix-end (or (match-end 1) (match-end 2)) | 2239 | (setq allout-recent-prefix-end (or (match-end 1) (match-end 2)) |
| 2239 | allout-recent-prefix-beginning (or (match-beginning 1) | 2240 | allout-recent-prefix-beginning (or (match-beginning 1) |
| 2240 | (match-beginning 2)) | 2241 | (match-beginning 2)) |
| @@ -2535,7 +2536,7 @@ Outermost is first." | |||
| 2535 | 2536 | ||
| 2536 | Returns the location of the heading, or nil if none found. | 2537 | Returns the location of the heading, or nil if none found. |
| 2537 | 2538 | ||
| 2538 | We skip anomolous low-level topics, a la `allout-aberrant-container-p'." | 2539 | We skip anomalous low-level topics, a la `allout-aberrant-container-p'." |
| 2539 | (if (looking-at allout-regexp) | 2540 | (if (looking-at allout-regexp) |
| 2540 | (forward-char 1)) | 2541 | (forward-char 1)) |
| 2541 | 2542 | ||
| @@ -2558,7 +2559,7 @@ We skip anomolous low-level topics, a la `allout-aberrant-container-p'." | |||
| 2558 | 2559 | ||
| 2559 | Return the location of the beginning of the heading, or nil if not found. | 2560 | Return the location of the beginning of the heading, or nil if not found. |
| 2560 | 2561 | ||
| 2561 | We skip anomolous low-level topics, a la `allout-aberrant-container-p'." | 2562 | We skip anomalous low-level topics, a la `allout-aberrant-container-p'." |
| 2562 | 2563 | ||
| 2563 | (if (bobp) | 2564 | (if (bobp) |
| 2564 | nil | 2565 | nil |
| @@ -3924,9 +3925,9 @@ Third arg NUMBER-CONTROL can force the prefix to or away from | |||
| 3924 | numbered form. It has effect only if `allout-numbered-bullet' is | 3925 | numbered form. It has effect only if `allout-numbered-bullet' is |
| 3925 | non-nil and soliciting was not explicitly invoked (via first arg). | 3926 | non-nil and soliciting was not explicitly invoked (via first arg). |
| 3926 | Its effect, numbering or denumbering, then depends on the setting | 3927 | Its effect, numbering or denumbering, then depends on the setting |
| 3927 | of the forth arg, INDEX. | 3928 | of the fourth arg, INDEX. |
| 3928 | 3929 | ||
| 3929 | If NUMBER-CONTROL is non-nil and forth arg INDEX is nil, then the | 3930 | If NUMBER-CONTROL is non-nil and fourth arg INDEX is nil, then the |
| 3930 | prefix of the topic is forced to be non-numbered. Null index and | 3931 | prefix of the topic is forced to be non-numbered. Null index and |
| 3931 | non-nil NUMBER-CONTROL forces denumbering. Non-nil INDEX (and | 3932 | non-nil NUMBER-CONTROL forces denumbering. Non-nil INDEX (and |
| 3932 | non-nil NUMBER-CONTROL) forces a numbered-prefix form. If non-nil | 3933 | non-nil NUMBER-CONTROL) forces a numbered-prefix form. If non-nil |
| @@ -4010,7 +4011,7 @@ this function." | |||
| 4010 | 4011 | ||
| 4011 | Descends into invisible as well as visible topics, however. | 4012 | Descends into invisible as well as visible topics, however. |
| 4012 | 4013 | ||
| 4013 | When optional sans-offspring is non-nil, subtopics are not | 4014 | When optional SANS-OFFSPRING is non-nil, subtopics are not |
| 4014 | shifted. (Shifting a topic outwards without shifting its | 4015 | shifted. (Shifting a topic outwards without shifting its |
| 4015 | offspring is disallowed, since this would create a \"containment | 4016 | offspring is disallowed, since this would create a \"containment |
| 4016 | discontinuity\", where the depth difference between a topic and | 4017 | discontinuity\", where the depth difference between a topic and |
| @@ -4055,7 +4056,7 @@ Finally, if optional SANS-OFFSPRING is non-nil then the offspring | |||
| 4055 | are not shifted. (Shifting a topic outwards without shifting | 4056 | are not shifted. (Shifting a topic outwards without shifting |
| 4056 | its offspring is disallowed, since this would create a | 4057 | its offspring is disallowed, since this would create a |
| 4057 | \"containment discontinuity\", where the depth difference between | 4058 | \"containment discontinuity\", where the depth difference between |
| 4058 | a topic and its immediate offspring is greater than one..)" | 4059 | a topic and its immediate offspring is greater than one.)" |
| 4059 | 4060 | ||
| 4060 | ;; XXX the recursion here is peculiar, and in general the routine may | 4061 | ;; XXX the recursion here is peculiar, and in general the routine may |
| 4061 | ;; need simplification with refactoring. | 4062 | ;; need simplification with refactoring. |
| @@ -4341,7 +4342,7 @@ Trailing whitespace is killed with a topic if that whitespace: | |||
| 4341 | previous one. | 4342 | previous one. |
| 4342 | 4343 | ||
| 4343 | Topic exposure is marked with text-properties, to be used by | 4344 | Topic exposure is marked with text-properties, to be used by |
| 4344 | allout-yank-processing for exposure recovery." | 4345 | `allout-yank-processing' for exposure recovery." |
| 4345 | 4346 | ||
| 4346 | (interactive) | 4347 | (interactive) |
| 4347 | (let* ((inhibit-field-text-motion t) | 4348 | (let* ((inhibit-field-text-motion t) |
| @@ -4372,7 +4373,7 @@ allout-yank-processing for exposure recovery." | |||
| 4372 | (run-hook-with-args 'allout-structure-deleted-hook depth (point)))) | 4373 | (run-hook-with-args 'allout-structure-deleted-hook depth (point)))) |
| 4373 | ;;;_ > allout-copy-topic-as-kill () | 4374 | ;;;_ > allout-copy-topic-as-kill () |
| 4374 | (defun allout-copy-topic-as-kill () | 4375 | (defun allout-copy-topic-as-kill () |
| 4375 | "Like allout-kill-topic, but save to kill ring instead of deleting." | 4376 | "Like `allout-kill-topic', but save to kill ring instead of deleting." |
| 4376 | (interactive) | 4377 | (interactive) |
| 4377 | (let ((buffer-read-only t)) | 4378 | (let ((buffer-read-only t)) |
| 4378 | (condition-case nil | 4379 | (condition-case nil |
| @@ -4874,8 +4875,8 @@ Useful for coherently exposing to a random point in a hidden region." | |||
| 4874 | ))) | 4875 | ))) |
| 4875 | ;;;_ > allout-show-current-subtree (&optional arg) | 4876 | ;;;_ > allout-show-current-subtree (&optional arg) |
| 4876 | (defun allout-show-current-subtree (&optional arg) | 4877 | (defun allout-show-current-subtree (&optional arg) |
| 4877 | "Show everything within the current topic. With a repeat-count, | 4878 | "Show everything within the current topic. |
| 4878 | expose this topic and its siblings." | 4879 | With a repeat-count, expose this topic and its siblings." |
| 4879 | (interactive "P") | 4880 | (interactive "P") |
| 4880 | (save-excursion | 4881 | (save-excursion |
| 4881 | (if (<= (allout-current-depth) 0) | 4882 | (if (<= (allout-current-depth) 0) |
| @@ -5288,7 +5289,7 @@ the subject region. | |||
| 5288 | 5289 | ||
| 5289 | Optional START and END indicate bounds of region. | 5290 | Optional START and END indicate bounds of region. |
| 5290 | 5291 | ||
| 5291 | optional arg, FORMAT, designates an alternate presentation form for | 5292 | Optional arg, FORMAT, designates an alternate presentation form for |
| 5292 | the prefix: | 5293 | the prefix: |
| 5293 | 5294 | ||
| 5294 | list - Present prefix as numeric section.subsection..., starting with | 5295 | list - Present prefix as numeric section.subsection..., starting with |
| @@ -5418,7 +5419,7 @@ FROMBUF to buffer TOBUF. Sixth optional arg, FORMAT, designates an | |||
| 5418 | alternate presentation form: | 5419 | alternate presentation form: |
| 5419 | 5420 | ||
| 5420 | `flat' - Present prefix as numeric section.subsection..., starting with | 5421 | `flat' - Present prefix as numeric section.subsection..., starting with |
| 5421 | section indicated by the start-num, innermost nesting first. | 5422 | section indicated by the START-NUM, innermost nesting first. |
| 5422 | X`flat-indented' - Prefix is like `flat' for first topic at each | 5423 | X`flat-indented' - Prefix is like `flat' for first topic at each |
| 5423 | X level, but subsequent topics have only leaf topic | 5424 | X level, but subsequent topics have only leaf topic |
| 5424 | X number, padded with blanks to line up with first. | 5425 | X number, padded with blanks to line up with first. |
| @@ -6292,8 +6293,8 @@ of the availability of a cached copy." | |||
| 6292 | 6293 | ||
| 6293 | The key type is one of 'symmetric or 'keypair. | 6294 | The key type is one of 'symmetric or 'keypair. |
| 6294 | 6295 | ||
| 6295 | if 'keypair, and some of the user's secret keys are among those for which | 6296 | If 'keypair, and some of the user's secret keys are among those for which |
| 6296 | the message was encoded, return the identity of the first. otherwise, | 6297 | the message was encoded, return the identity of the first. Otherwise, |
| 6297 | return nil for the second item of the pair. | 6298 | return nil for the second item of the pair. |
| 6298 | 6299 | ||
| 6299 | An error is raised if the text is not encrypted." | 6300 | An error is raised if the text is not encrypted." |
| @@ -6338,7 +6339,7 @@ An error is raised if the text is not encrypted." | |||
| 6338 | See `allout-passphrase-verifier-string' and `allout-passphrase-hint-string' | 6339 | See `allout-passphrase-verifier-string' and `allout-passphrase-hint-string' |
| 6339 | settings. | 6340 | settings. |
| 6340 | 6341 | ||
| 6341 | PASSPHRASE is the passphrase being mnemonicized | 6342 | PASSPHRASE is the passphrase being mnemonicized. |
| 6342 | 6343 | ||
| 6343 | OUTLINE-BUFFER is the buffer of the outline being adjusted. | 6344 | OUTLINE-BUFFER is the buffer of the outline being adjusted. |
| 6344 | 6345 | ||
| @@ -6416,7 +6417,7 @@ EXCEPT-MARK identifies a point whose containing topics should be excluded | |||
| 6416 | from encryption. This supports 'except-current mode of | 6417 | from encryption. This supports 'except-current mode of |
| 6417 | `allout-encrypt-unencrypted-on-saves'. | 6418 | `allout-encrypt-unencrypted-on-saves'. |
| 6418 | 6419 | ||
| 6419 | Such a topic has the allout-topic-encryption-bullet without an | 6420 | Such a topic has the `allout-topic-encryption-bullet' without an |
| 6420 | immediately following '*' that would mark the topic as being encrypted. It | 6421 | immediately following '*' that would mark the topic as being encrypted. It |
| 6421 | must also have content." | 6422 | must also have content." |
| 6422 | (let (done got content-beg) | 6423 | (let (done got content-beg) |
| @@ -6746,7 +6747,7 @@ If BEG is bigger than END we return 0." | |||
| 6746 | (cond ((null list) nil) | 6747 | (cond ((null list) nil) |
| 6747 | ((atom (car list)) (cons (car list) (allout-flatten (cdr list)))) | 6748 | ((atom (car list)) (cons (car list) (allout-flatten (cdr list)))) |
| 6748 | (t (append (allout-flatten (car list)) (allout-flatten (cdr list)))))) | 6749 | (t (append (allout-flatten (car list)) (allout-flatten (cdr list)))))) |
| 6749 | ;;;_ : Compatability: | 6750 | ;;;_ : Compatibility: |
| 6750 | ;;;_ > allout-mark-marker to accommodate divergent emacsen: | 6751 | ;;;_ > allout-mark-marker to accommodate divergent emacsen: |
| 6751 | (defun allout-mark-marker (&optional force buffer) | 6752 | (defun allout-mark-marker (&optional force buffer) |
| 6752 | "Accommodate the different signature for `mark-marker' across Emacsen. | 6753 | "Accommodate the different signature for `mark-marker' across Emacsen. |
| @@ -6938,7 +6939,7 @@ To ignore intangibility, bind `inhibit-point-motion-hooks' to t." | |||
| 6938 | (defvar allout-tests-globally-unbound nil | 6939 | (defvar allout-tests-globally-unbound nil |
| 6939 | "Fodder for allout resumptions tests - defvar just for byte compiler.") | 6940 | "Fodder for allout resumptions tests - defvar just for byte compiler.") |
| 6940 | (defvar allout-tests-globally-true nil | 6941 | (defvar allout-tests-globally-true nil |
| 6941 | "Fodder for allout resumptions tests - defvar just just for byte compiler.") | 6942 | "Fodder for allout resumptions tests - defvar just for byte compiler.") |
| 6942 | (defvar allout-tests-locally-true nil | 6943 | (defvar allout-tests-locally-true nil |
| 6943 | "Fodder for allout resumptions tests - defvar just for byte compiler.") | 6944 | "Fodder for allout resumptions tests - defvar just for byte compiler.") |
| 6944 | (defun allout-test-resumptions () | 6945 | (defun allout-test-resumptions () |