Commit fa5f7c5f authored by Juanma Barranquero's avatar Juanma Barranquero

Fix typos in docstrings.

* outline.el (outline-head-from-level):
* simple.el (with-wrapper-hook):
* cedet/ede.el (ede-run-target, project-delete-target)
  (project-dist-files, ede-name, ede-documentation, ede-parent-project)
  (ede-adebug-project, ede-adebug-project-parent)
  (ede-adebug-project-root):
* emacs-lisp/elint.el (elint-extra-errors, elint-current-buffer)
  (elint-defun, elint-buffer-env, elint-top-form-logged)
  (elint-unbound-variable):
* textmodes/reftex-toc.el (reftex-toc-newhead-from-alist):
parent ecbaeb7b
2010-02-14 Juanma Barranquero <lekktu@gmail.com>
* outline.el (outline-head-from-level):
* simple.el (with-wrapper-hook):
* cedet/ede.el (ede-run-target, project-delete-target)
(project-dist-files, ede-name, ede-documentation, ede-parent-project)
(ede-adebug-project, ede-adebug-project-parent)
(ede-adebug-project-root):
* emacs-lisp/elint.el (elint-extra-errors, elint-current-buffer)
(elint-defun, elint-buffer-env, elint-top-form-logged)
(elint-unbound-variable):
* textmodes/reftex-toc.el (reftex-toc-newhead-from-alist):
Fix typos in docstrings.
2010-02-14 Michael Albinus <michael.albinus@gmx.de> 2010-02-14 Michael Albinus <michael.albinus@gmx.de>
* files.el (insert-directory): When WILDCARD-REGEXP and * files.el (insert-directory): When WILDCARD-REGEXP and
......
...@@ -1155,7 +1155,7 @@ Optional argument FORCE forces the file to be removed without asking." ...@@ -1155,7 +1155,7 @@ Optional argument FORCE forces the file to be removed without asking."
(ede-invoke-method 'project-debug-target)) (ede-invoke-method 'project-debug-target))
(defun ede-run-target () (defun ede-run-target ()
"Debug the current buffer's assocated target." "Run the current buffer's associated target."
(interactive) (interactive)
(ede-invoke-method 'project-run-target)) (ede-invoke-method 'project-run-target))
...@@ -1381,7 +1381,7 @@ Argument FNND is an argument." ...@@ -1381,7 +1381,7 @@ Argument FNND is an argument."
(error "New-target-custom not supported by %s" (object-name proj))) (error "New-target-custom not supported by %s" (object-name proj)))
(defmethod project-delete-target ((ot ede-target)) (defmethod project-delete-target ((ot ede-target))
"Delete the current target OT from it's parent project." "Delete the current target OT from its parent project."
(error "add-file not supported by %s" (object-name ot))) (error "add-file not supported by %s" (object-name ot)))
(defmethod project-compile-project ((obj ede-project) &optional command) (defmethod project-compile-project ((obj ede-project) &optional command)
...@@ -1407,7 +1407,7 @@ Argument COMMAND is the command to use for compiling the target." ...@@ -1407,7 +1407,7 @@ Argument COMMAND is the command to use for compiling the target."
(error "Make-dist not supported by %s" (object-name this))) (error "Make-dist not supported by %s" (object-name this)))
(defmethod project-dist-files ((this ede-project)) (defmethod project-dist-files ((this ede-project))
"Return a list of files that constitutes a distribution of THIS project." "Return a list of files that constitute a distribution of THIS project."
(error "Dist-files is not supported by %s" (object-name this))) (error "Dist-files is not supported by %s" (object-name this)))
(defmethod project-rescan ((this ede-project)) (defmethod project-rescan ((this ede-project))
...@@ -1421,7 +1421,7 @@ Argument COMMAND is the command to use for compiling the target." ...@@ -1421,7 +1421,7 @@ Argument COMMAND is the command to use for compiling the target."
;; b) cosmetic. ;; b) cosmetic.
(defmethod ede-name ((this ede-target)) (defmethod ede-name ((this ede-target))
"Return the name of THIS targt." "Return the name of THIS target."
(oref this name)) (oref this name))
(defmethod ede-target-name ((this ede-target)) (defmethod ede-target-name ((this ede-target))
...@@ -1510,7 +1510,7 @@ Also do a quick check to see if there is a Documentation tag in this BUFFER." ...@@ -1510,7 +1510,7 @@ Also do a quick check to see if there is a Documentation tag in this BUFFER."
(ede-buffer-documentation-files cp (current-buffer)))))) (ede-buffer-documentation-files cp (current-buffer))))))
(defmethod ede-documentation ((this ede-project)) (defmethod ede-documentation ((this ede-project))
"Return a list of files that provides documentation. "Return a list of files that provide documentation.
Documentation is not for object THIS, but is provided by THIS for other Documentation is not for object THIS, but is provided by THIS for other
files in the project." files in the project."
(let ((targ (oref this targets)) (let ((targ (oref this targets))
...@@ -1525,7 +1525,7 @@ files in the project." ...@@ -1525,7 +1525,7 @@ files in the project."
found)) found))
(defmethod ede-documentation ((this ede-target)) (defmethod ede-documentation ((this ede-target))
"Return a list of files that provides documentation. "Return a list of files that provide documentation.
Documentation is not for object THIS, but is provided by THIS for other Documentation is not for object THIS, but is provided by THIS for other
files in the project." files in the project."
nil) nil)
...@@ -1651,7 +1651,7 @@ Optional ROOTRETURN will return the root project for DIR." ...@@ -1651,7 +1651,7 @@ Optional ROOTRETURN will return the root project for DIR."
(defun ede-parent-project (&optional obj) (defun ede-parent-project (&optional obj)
"Return the project belonging to the parent directory. "Return the project belonging to the parent directory.
nil if there is no previous directory. Returns nil if there is no previous directory.
Optional argument OBJ is an object to find the parent of." Optional argument OBJ is an object to find the parent of."
(let* ((proj (or obj ede-object-project)) ;; Current project. (let* ((proj (or obj ede-object-project)) ;; Current project.
(root (if obj (ede-project-root obj) (root (if obj (ede-project-root obj)
...@@ -1952,7 +1952,7 @@ is the project to use, instead of `ede-current-project'." ...@@ -1952,7 +1952,7 @@ is the project to use, instead of `ede-current-project'."
;;; Debugging. ;;; Debugging.
(defun ede-adebug-project () (defun ede-adebug-project ()
"Run adebug against the current ede project. "Run adebug against the current EDE project.
Display the results as a debug list." Display the results as a debug list."
(interactive) (interactive)
(require 'data-debug) (require 'data-debug)
...@@ -1962,7 +1962,7 @@ Display the results as a debug list." ...@@ -1962,7 +1962,7 @@ Display the results as a debug list."
)) ))
(defun ede-adebug-project-parent () (defun ede-adebug-project-parent ()
"Run adebug against the current ede parent project. "Run adebug against the current EDE parent project.
Display the results as a debug list." Display the results as a debug list."
(interactive) (interactive)
(require 'data-debug) (require 'data-debug)
...@@ -1972,7 +1972,7 @@ Display the results as a debug list." ...@@ -1972,7 +1972,7 @@ Display the results as a debug list."
)) ))
(defun ede-adebug-project-root () (defun ede-adebug-project-root ()
"Run adebug against the current ede parent project. "Run adebug against the current EDE parent project.
Display the results as a debug list." Display the results as a debug list."
(interactive) (interactive)
(require 'data-debug) (require 'data-debug)
...@@ -1983,7 +1983,7 @@ Display the results as a debug list." ...@@ -1983,7 +1983,7 @@ Display the results as a debug list."
;;; Hooks & Autoloads ;;; Hooks & Autoloads
;; ;;
;; These let us watch various activities, and respond apropriatly. ;; These let us watch various activities, and respond appropriately.
;; (add-hook 'edebug-setup-hook ;; (add-hook 'edebug-setup-hook
;; (lambda () ;; (lambda ()
......
...@@ -147,7 +147,7 @@ Set by `elint-initialize', if `elint-scan-preloaded' is non-nil.") ...@@ -147,7 +147,7 @@ Set by `elint-initialize', if `elint-scan-preloaded' is non-nil.")
"Those built-ins for which we can't find arguments, if any.") "Those built-ins for which we can't find arguments, if any.")
(defvar elint-extra-errors '(file-locked file-supersession ftp-error) (defvar elint-extra-errors '(file-locked file-supersession ftp-error)
"Errors without error-message or error-confitions properties.") "Errors without `error-message' or `error-conditions' properties.")
(defconst elint-preloaded-skip-re (defconst elint-preloaded-skip-re
(regexp-opt '("loaddefs.el" "loadup.el" "cus-start" "language/" (regexp-opt '("loaddefs.el" "loadup.el" "cus-start" "language/"
...@@ -289,7 +289,7 @@ A complicated directory may require a lot of memory." ...@@ -289,7 +289,7 @@ A complicated directory may require a lot of memory."
;;;###autoload ;;;###autoload
(defun elint-current-buffer () (defun elint-current-buffer ()
"Lint the current buffer. "Lint the current buffer.
If necessary, this first calls `elint-initalize'." If necessary, this first calls `elint-initialize'."
(interactive) (interactive)
(or elint-builtin-variables (or elint-builtin-variables
(elint-initialize)) (elint-initialize))
...@@ -308,7 +308,7 @@ If necessary, this first calls `elint-initalize'." ...@@ -308,7 +308,7 @@ If necessary, this first calls `elint-initalize'."
;;;###autoload ;;;###autoload
(defun elint-defun () (defun elint-defun ()
"Lint the function at point. "Lint the function at point.
If necessary, this first calls `elint-initalize'." If necessary, this first calls `elint-initialize'."
(interactive) (interactive)
(or elint-builtin-variables (or elint-builtin-variables
(elint-initialize)) (elint-initialize))
...@@ -325,7 +325,7 @@ If necessary, this first calls `elint-initalize'." ...@@ -325,7 +325,7 @@ If necessary, this first calls `elint-initalize'."
;;; ;;;
(defvar elint-buffer-env nil (defvar elint-buffer-env nil
"The environment of a elisp buffer. "The environment of an elisp buffer.
Will be local in linted buffers.") Will be local in linted buffers.")
(defvar elint-buffer-forms nil (defvar elint-buffer-forms nil
...@@ -528,7 +528,7 @@ Return nil if there are no more forms, t otherwise." ...@@ -528,7 +528,7 @@ Return nil if there are no more forms, t otherwise."
"The currently linted top form, or nil.") "The currently linted top form, or nil.")
(defvar elint-top-form-logged nil (defvar elint-top-form-logged nil
"T if the currently linted top form has been mentioned in the log buffer.") "The value t if the currently linted top form has been mentioned in the log buffer.")
(defun elint-top-form (form) (defun elint-top-form (form)
"Lint a top FORM." "Lint a top FORM."
...@@ -640,7 +640,7 @@ Returns the environment created by the form." ...@@ -640,7 +640,7 @@ Returns the environment created by the form."
"Name of a temporarily bound symbol.") "Name of a temporarily bound symbol.")
(defun elint-unbound-variable (var env) (defun elint-unbound-variable (var env)
"T if VAR is unbound in ENV." "Return t if VAR is unbound in ENV."
;; #1063 suggests adding (symbol-file var) here, but I don't think ;; #1063 suggests adding (symbol-file var) here, but I don't think
;; this is right, because it depends on what files you happen to have ;; this is right, because it depends on what files you happen to have
;; loaded at the time, which might not be the same when the code runs. ;; loaded at the time, which might not be the same when the code runs.
......
...@@ -595,7 +595,7 @@ If there are no such entries, return nil. ...@@ -595,7 +595,7 @@ If there are no such entries, return nil.
ALIST defaults to `outline-heading-alist'. ALIST defaults to `outline-heading-alist'.
Similar to (car (rassoc LEVEL ALIST)). Similar to (car (rassoc LEVEL ALIST)).
If there are several different entries with same new level, choose If there are several different entries with same new level, choose
the one with the smallest distance to the assocation of HEAD in the alist. the one with the smallest distance to the association of HEAD in the alist.
This makes it possible for promotion to work in modes with several This makes it possible for promotion to work in modes with several
independent sets of headings (numbered, unnumbered, appendix...)" independent sets of headings (numbered, unnumbered, appendix...)"
(unless alist (setq alist outline-heading-alist)) (unless alist (setq alist outline-heading-alist))
......
...@@ -6552,7 +6552,7 @@ VAR is normally a symbol (a variable) in which case it is treated like ...@@ -6552,7 +6552,7 @@ VAR is normally a symbol (a variable) in which case it is treated like
a hook, with a buffer-local and a global part. But it can also be an a hook, with a buffer-local and a global part. But it can also be an
arbitrary expression. arbitrary expression.
ARGS is a list of variables which will be passed as additional arguments ARGS is a list of variables which will be passed as additional arguments
to each function, after the inital argument, and which the first argument to each function, after the initial argument, and which the first argument
expects to receive when called." expects to receive when called."
(declare (indent 2) (debug t)) (declare (indent 2) (debug t))
;; We need those two gensyms because CL's lexical scoping is not available ;; We need those two gensyms because CL's lexical scoping is not available
......
...@@ -723,8 +723,8 @@ DELTA and PRO-OR-DE are assumed to be dynamically scoped into this function." ...@@ -723,8 +723,8 @@ DELTA and PRO-OR-DE are assumed to be dynamically scoped into this function."
(defun reftex-toc-newhead-from-alist (nlevel head alist) (defun reftex-toc-newhead-from-alist (nlevel head alist)
"Get new heading with level NLEVEL from ALIST. "Get new heading with level NLEVEL from ALIST.
If there are no such entries, return nil. If there are no such entries, return nil.
If there are several different entries with same new level, choose If there are several different entries with same new level, choose the
the one with the smallest distance to the assocation of HEAD in the alist. one with the smallest distance to the association of HEAD in the alist.
This makes it possible for promotion to work several sets of headings, This makes it possible for promotion to work several sets of headings,
if these sets are sorted blocks in the alist." if these sets are sorted blocks in the alist."
(let* ((al alist) (let* ((al alist)
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment