From a64dc1a44c395c179b44d8b4f2ffa79cf7dd1ab5 Mon Sep 17 00:00:00 2001 From: Luc Teirlinck Date: Fri, 8 Apr 2005 23:10:24 +0000 Subject: [PATCH] (defun-prompt-regexp, parens-require-spaces, buffer-end, end-of-defun) (insert-parentheses): Doc fixes. --- lisp/emacs-lisp/lisp.el | 20 ++++++++++---------- 1 file changed, 10 insertions(+), 10 deletions(-) diff --git a/lisp/emacs-lisp/lisp.el b/lisp/emacs-lisp/lisp.el index d0a2fdc01da..f9442bc0084 100644 --- a/lisp/emacs-lisp/lisp.el +++ b/lisp/emacs-lisp/lisp.el @@ -31,18 +31,16 @@ ;; Note that this variable is used by non-lisp modes too. (defcustom defun-prompt-regexp nil - "*If non-nil, a regexp to ignore before the character that starts a defun. + "*If non-nil, a regexp to ignore before a defun. This is only necessary if the opening paren or brace is not in column 0. -See function `beginning-of-defun'. - -Setting this variable automatically makes it local to the current buffer." +See function `beginning-of-defun'." :type '(choice (const nil) regexp) :group 'lisp) (make-variable-buffer-local 'defun-prompt-regexp) (defcustom parens-require-spaces t - "Non-nil means `insert-parentheses' should insert whitespace as needed." + "If non-nil, `insert-parentheses' inserts whitespace as needed." :type 'boolean :group 'lisp) @@ -74,7 +72,7 @@ move forward across N balanced expressions." The place mark goes is the same place \\[forward-sexp] would move to with the same argument. Interactively, if this command is repeated -or (in Transient Mark mode) if the mark is active, +or (in Transient Mark mode) if the mark is active, it marks the next ARG sexps after the ones already marked." (interactive "P\np") (cond ((and allow-extend @@ -233,13 +231,14 @@ recipe (see `end-of-defun'). Major modes can define this if the normal method is not appropriate.") (defun buffer-end (arg) - "Return the \"far end\" position of the buffer, moving in direction ARG. + "Return the \"far end\" position of the buffer, in direction ARG. If ARG is positive, that's the end of the buffer. Otherwise, that's the beginning of the buffer." (if (> arg 0) (point-max) (point-min))) (defun end-of-defun (&optional arg) - "Move forward to next end of defun. With argument, do it that many times. + "Move forward to next end of defun. +With argument, do it that many times. Negative argument -N means move back to Nth preceding end of defun. An end of a defun occurs right after the close-parenthesis that @@ -299,7 +298,7 @@ is called as a function to find the defun's end." The defun marked is the one that contains point or follows point. Interactively, if this command is repeated -or (in Transient Mark mode) if the mark is active, +or (in Transient Mark mode) if the mark is active, it marks the next defun after the ones already marked." (interactive "p") (cond ((and allow-extend @@ -424,7 +423,8 @@ character is inserted ARG times." (prefix-numeric-value arg)))) (defun insert-parentheses (&optional arg) - "Enclose following ARG sexps in parentheses. Leave point after open-paren. + "Enclose following ARG sexps in parentheses. +Leave point after open-paren. A negative ARG encloses the preceding ARG sexps instead. No argument is equivalent to zero: just insert `()' and leave point between. If `parens-require-spaces' is non-nil, this command also inserts a space -- 2.39.2