diff options
| author | Lars Ingebrigtsen <larsi@gnus.org> | 2019-08-17 14:52:15 -0700 |
|---|---|---|
| committer | Lars Ingebrigtsen <larsi@gnus.org> | 2019-08-17 16:35:59 -0700 |
| commit | 669599b0f4b59029fd977609be02f754a3b075eb (patch) | |
| tree | e82a0bed9f7ad258cb53a698f3e7d9f78878f635 /lisp/newcomment.el | |
| parent | c90a420779448fecf1941f063da3e8276dc3d0d7 (diff) | |
| download | emacs-669599b0f4b59029fd977609be02f754a3b075eb.tar.gz | |
Doc clarification in two comment-* functions
* lisp/newcomment.el (comment-padright, comment-padleft): Note
that `comment-normalize-vars' must be called first (bug#11944).
Diffstat (limited to 'lisp/newcomment.el')
| -rw-r--r-- | lisp/newcomment.el | 10 |
1 files changed, 7 insertions, 3 deletions
diff --git a/lisp/newcomment.el b/lisp/newcomment.el index ac706b949ba..027c20430cc 100644 --- a/lisp/newcomment.el +++ b/lisp/newcomment.el @@ -825,7 +825,9 @@ If STR already contains padding, the corresponding amount is ignored from `comment-padding'. N defaults to 0. If N is `re', a regexp is returned instead, that would match -the string for any N." +the string for any N. + +Ensure that `comment-normalize-vars' has been called before you use this." (setq n (or n 0)) (when (and (stringp str) (string-match "\\S-" str)) ;; Separate the actual string from any leading/trailing padding @@ -860,8 +862,10 @@ It also adds N copies of the first non-whitespace chars of STR. If STR already contains padding, the corresponding amount is ignored from `comment-padding'. N defaults to 0. -If N is `re', a regexp is returned instead, that would match - the string for any N." +If N is `re', a regexp is returned instead, that would match the +string for any N. + +Ensure that `comment-normalize-vars' has been called before you use this." (setq n (or n 0)) (when (and (stringp str) (not (string= "" str))) ;; Only separate the left pad because we assume there is no right pad. |