mirror of
git://git.sv.gnu.org/emacs.git
synced 2026-01-30 04:10:54 -08:00
Fix typos in docstrings.
This commit is contained in:
Juanma Barranquero
parent
80cd4bb402
commit
d1f18ec092
15 changed files with 77 additions and 51 deletions
|
|
@ -1,5 +1,22 @@
|
|||
2010-01-14 Juanma Barranquero <lekktu@gmail.com>
|
||||
|
||||
* find-cmd.el (find-constituents):
|
||||
* vc-arch.el (vc-arch-root):
|
||||
* window.el (window-body-height, pop-up-frames):
|
||||
* cedet/semantic/edit.el (semantic-reparse-needed-change-hook)
|
||||
(semantic-no-reparse-needed-change-hook):
|
||||
* cedet/srecode/insert.el (srecode-resolve-argument-list)
|
||||
(srecode-template-inserter-blank, srecode-template-inserter-variable)
|
||||
(srecode-template-inserter-ask, srecode-template-inserter-width)
|
||||
(srecode-template-inserter-section-start)
|
||||
(srecode-template-inserter-section-end, srecode-insert-method):
|
||||
* emacs-lisp/eieio-base.el (eieio-singleton, slot-missing):
|
||||
* progmodes/ada-stmt.el (ada-if):
|
||||
* progmodes/gdb-ui.el (gdb-jsonify-buffer):
|
||||
* textmodes/ispell.el (ispell-grep-options, ispell-dictionary-alist)
|
||||
(ispell-encoding8-command, ispell-aspell-supports-utf8)
|
||||
(ispell-last-program-name, ispell-help): Fix typos in docstrings.
|
||||
|
||||
* progmodes/flymake.el (flymake-post-syntax-check):
|
||||
Fix typo in error message.
|
||||
|
||||
|
|
|
|||
|
|
@ -81,15 +81,13 @@ common hook `after-change-functions'.")
|
|||
|
||||
(defvar semantic-reparse-needed-change-hook nil
|
||||
"Hooks run when a user edit is detected as needing a reparse.
|
||||
For language specific hooks, make sure you define this as a local
|
||||
hook.
|
||||
Not used yet; part of the next generation reparse mechanism")
|
||||
For language specific hooks, make sure you define this as a local hook.
|
||||
Not used yet; part of the next generation reparse mechanism.")
|
||||
|
||||
(defvar semantic-no-reparse-needed-change-hook nil
|
||||
"Hooks run when a user edit is detected as not needing a reparse.
|
||||
If the hook returns non-nil, then declare that a reparse is needed.
|
||||
For language specific hooks, make sure you define this as a local
|
||||
hook.
|
||||
For language specific hooks, make sure you define this as a local hook.
|
||||
Not used yet; part of the next generation reparse mechanism.")
|
||||
|
||||
(defvar semantic-edits-new-change-hooks nil
|
||||
|
|
@ -307,7 +305,7 @@ See `semantic-edits-change-leaf-tag' for details on parents."
|
|||
(semantic-tag-components (car tags)))
|
||||
;; Ok, we are completely encompassed within the first tag
|
||||
;; entry, AND that tag has children. This means that change
|
||||
;; occured outside of all children, but inside some tag
|
||||
;; occurred outside of all children, but inside some tag
|
||||
;; with children.
|
||||
(if (or (not (semantic-tag-with-position-p (car list-to-search)))
|
||||
(> start (semantic-tag-end
|
||||
|
|
@ -751,7 +749,7 @@ This function is for internal use by `semantic-edits-incremental-parser'."
|
|||
|
||||
;;;; Whitespace change
|
||||
((and (not tags) (not newf-tags))
|
||||
;; A change that occured outside of any existing tags
|
||||
;; A change that occurred outside of any existing tags
|
||||
;; and there are no new tags to replace it.
|
||||
(when semantic-edits-verbose-flag
|
||||
(message "White space changes"))
|
||||
|
|
@ -760,7 +758,7 @@ This function is for internal use by `semantic-edits-incremental-parser'."
|
|||
|
||||
;;;; New tags in old whitespace area.
|
||||
((and (not tags) newf-tags)
|
||||
;; A change occured outside existing tags which added
|
||||
;; A change occurred outside existing tags which added
|
||||
;; a new tag. We need to splice these tags back
|
||||
;; into the cache at the right place.
|
||||
(semantic-edits-splice-insert newf-tags parent-tag cache-list)
|
||||
|
|
@ -775,7 +773,7 @@ This function is for internal use by `semantic-edits-incremental-parser'."
|
|||
|
||||
;;;; Old tags removed
|
||||
((and tags (not newf-tags))
|
||||
;; A change occured where pre-existing tags were
|
||||
;; A change occurred where pre-existing tags were
|
||||
;; deleted! Remove the tag from the cache.
|
||||
(semantic-edits-splice-remove tags parent-tag cache-list)
|
||||
|
||||
|
|
|
|||
|
|
@ -201,7 +201,7 @@ Apply anything learned to the dictionary DICT."
|
|||
"Resolve arguments in the argument list ARGS.
|
||||
ARGS is a list of symbols, such as :blank, or :file.
|
||||
Apply values to DICT.
|
||||
Optional argument TEMP is the template that is getting it's arguments resolved."
|
||||
Optional argument TEMP is the template that is getting its arguments resolved."
|
||||
(let ((fcn nil))
|
||||
(while args
|
||||
(setq fcn (intern-soft (concat "srecode-semantic-handle-"
|
||||
|
|
@ -334,14 +334,14 @@ occur in your template.")
|
|||
((key :initform "\r"
|
||||
:allocation :class
|
||||
:documentation
|
||||
"The character represeinting this inserter style.
|
||||
"The character representing this inserter style.
|
||||
Can't be blank, or it might be used by regular variable insertion.")
|
||||
(where :initform 'begin
|
||||
:initarg :where
|
||||
:documentation
|
||||
"This should be 'begin or 'end, indicating where to insrt a CR.
|
||||
"This should be 'begin or 'end, indicating where to insert a CR.
|
||||
When set to 'begin, it will insert a CR if we are not at 'bol'.
|
||||
When set to 'end it will insert a CR if we are not at 'eol'")
|
||||
When set to 'end it will insert a CR if we are not at 'eol'.")
|
||||
;; @TODO - Add slot and control for the number of blank
|
||||
;; lines before and after point.
|
||||
)
|
||||
|
|
@ -407,7 +407,7 @@ Arguments ESCAPE-START and ESCAPE-END are the current escape sequences in use."
|
|||
:allocation :class
|
||||
:documentation
|
||||
"The character code used to identify inserters of this style."))
|
||||
"Insert the value of a dictionary entry
|
||||
"Insert the value of a dictionary entry.
|
||||
If there is no entry, insert nothing.")
|
||||
|
||||
(defvar srecode-inserter-variable-current-dictionary nil
|
||||
|
|
@ -493,7 +493,7 @@ If SECONDNAME is nil, return VALUE."
|
|||
:documentation
|
||||
"The function used to read in the text for this prompt.")
|
||||
)
|
||||
"Insert the value of a dictionary entry
|
||||
"Insert the value of a dictionary entry.
|
||||
If there is no entry, prompt the user for the value to use.
|
||||
The prompt text used is derived from the previous PROMPT command in the
|
||||
template file.")
|
||||
|
|
@ -626,8 +626,8 @@ Use DICTIONARY to resolve values."
|
|||
"The character code used to identify inserters of this style.")
|
||||
)
|
||||
"Inserts the value of a dictionary variable with a specific width.
|
||||
The second argument specifies the width, and a pad, seperated by a colon.
|
||||
thus a specification of `10:left' will insert the value of A
|
||||
The second argument specifies the width, and a pad, separated by a colon.
|
||||
Thus a specification of `10:left' will insert the value of A
|
||||
to 10 characters, with spaces added to the left. Use `right' for adding
|
||||
spaces to the right.")
|
||||
|
||||
|
|
@ -771,7 +771,7 @@ Calls back to `srecode-insert-method-helper' for this class."
|
|||
"The character code used to identify inserters of this style.")
|
||||
(template :initarg :template
|
||||
:documentation
|
||||
"A Template used to frame the codes from this inserter.")
|
||||
"A template used to frame the codes from this inserter.")
|
||||
)
|
||||
"Apply values from a sub-dictionary to a template section.
|
||||
The dictionary saved at the named dictionary entry will be
|
||||
|
|
@ -806,7 +806,7 @@ Return the remains of INPUT."
|
|||
:documentation
|
||||
"The character code used to identify inserters of this style.")
|
||||
)
|
||||
"All template segments between the secion-start and section-end
|
||||
"All template segments between the section-start and section-end
|
||||
are treated specially.")
|
||||
|
||||
(defmethod srecode-insert-method ((sti srecode-template-inserter-section-end)
|
||||
|
|
@ -881,7 +881,7 @@ this template instance."
|
|||
(setq active (cdr active)))
|
||||
(when (not tmpl)
|
||||
;; If it wasn't in this context, look to see if it
|
||||
;; defines it's own context
|
||||
;; defines its own context
|
||||
(setq tmpl (srecode-template-get-table (srecode-table)
|
||||
templatenamepart)))
|
||||
)
|
||||
|
|
@ -897,7 +897,7 @@ this template instance."
|
|||
dictionary)
|
||||
"Insert the STI inserter.
|
||||
Finds the template with this macro function part, and inserts it
|
||||
with the dictionaries found in the dictinary."
|
||||
with the dictionaries found in the dictionary."
|
||||
(srecode-insert-include-lookup sti dictionary)
|
||||
;; Insert the template.
|
||||
;; Our baseclass has a simple way to do this.
|
||||
|
|
@ -952,7 +952,7 @@ Arguments ESCAPE-START and ESCAPE-END are the current escape sequences in use."
|
|||
"Insert the template STI.
|
||||
This will first insert the include part via inheritance, then
|
||||
insert the section it wraps into the location in the included
|
||||
template where a ^ inserter occurs."
|
||||
template where a ^ inserter occurs."
|
||||
;; Step 1: Look up the included inserter
|
||||
(srecode-insert-include-lookup sti dictionary)
|
||||
;; Step 2: Temporarilly override the point inserter.
|
||||
|
|
|
|||
|
|
@ -150,7 +150,7 @@ Returns the first match."
|
|||
"The only instance of this class that will be instantiated.
|
||||
Multiple calls to `make-instance' will return this object."))
|
||||
"This special class causes subclasses to be singletons.
|
||||
A singleton is a class which will only ever have one instace."
|
||||
A singleton is a class which will only ever have one instance."
|
||||
:abstract t)
|
||||
|
||||
(defmethod constructor :STATIC ((class eieio-singleton) name &rest slots)
|
||||
|
|
@ -309,7 +309,7 @@ access to it."
|
|||
|
||||
(defmethod slot-missing ((obj eieio-named)
|
||||
slot-name operation &optional new-value)
|
||||
"Called when a on-existant slot is accessed.
|
||||
"Called when a non-existent slot is accessed.
|
||||
For variable `eieio-named', provide an imaginary `object-name' slot.
|
||||
Argument OBJ is the named object.
|
||||
Argument SLOT-NAME is the slot that was attempted to be accessed.
|
||||
|
|
|
|||
|
|
@ -122,7 +122,7 @@
|
|||
(okdir . (1 find-command t)))
|
||||
"Holds details of each of the find options.
|
||||
The car of each alist is the name. The cdr is minimum args, the
|
||||
function used to join many occurences of the argument together,
|
||||
function used to join many occurrences of the argument together,
|
||||
and whether or not to leave quotes off the string (non-nil means
|
||||
the string will be quoted).")
|
||||
|
||||
|
|
|
|||
|
|
@ -1,3 +1,8 @@
|
|||
2010-01-14 Juanma Barranquero <lekktu@gmail.com>
|
||||
|
||||
* org-protocol.el (org-protocol-flatten-greedy, org-protocol-flatten):
|
||||
Fix typos in docstrings.
|
||||
|
||||
2010-01-01 Juanma Barranquero <lekktu@gmail.com>
|
||||
|
||||
* org.el (org-get-outline-path, org-speed-command-help):
|
||||
|
|
|
|||
|
|
@ -355,9 +355,9 @@ encodeURIComponent. E.g. `%C3%B6' is the german Umlaut `ü'."
|
|||
ret ))
|
||||
|
||||
(defun org-protocol-flatten-greedy (param-list &optional strip-path replacement)
|
||||
"Greedy handlers might recieve a list like this from emacsclient:
|
||||
"Greedy handlers might receive a list like this from emacsclient:
|
||||
'( (\"/dir/org-protocol:/greedy:/~/path1\" (23 . 12)) (\"/dir/param\")
|
||||
where \"/dir/\" is the absolute path to emacsclients working directory. This
|
||||
where \"/dir/\" is the absolute path to emacsclients working directory. This
|
||||
function transforms it into a flat list utilizing `org-protocol-flatten' and
|
||||
transforms the elements of that list as follows:
|
||||
|
||||
|
|
@ -400,10 +400,10 @@ returned list."
|
|||
|
||||
|
||||
(defun org-protocol-flatten (l)
|
||||
"Greedy handlers might recieve a list like this from emacsclient:
|
||||
"Greedy handlers might receive a list like this from emacsclient:
|
||||
'( (\"/dir/org-protocol:/greedy:/~/path1\" (23 . 12)) (\"/dir/param\")
|
||||
where \"/dir/\" is the absolute path to emacsclients working directory. This
|
||||
function transforms it into a flat list."
|
||||
where \"/dir/\" is the absolute path to emacsclients working directory.
|
||||
This function transforms it into a flat list."
|
||||
(if (null l) ()
|
||||
(if (listp l)
|
||||
(append (org-protocol-flatten (car l)) (org-protocol-flatten (cdr l)))
|
||||
|
|
|
|||
|
|
@ -187,7 +187,7 @@ Indent for the first line of code."
|
|||
|
||||
|
||||
(define-skeleton ada-if
|
||||
"Insert skeleton if statment, prompting for a boolean-expression."
|
||||
"Insert skeleton if statement, prompting for a boolean-expression."
|
||||
"[condition]: "
|
||||
"if " str " then" \n
|
||||
> _ \n
|
||||
|
|
|
|||
|
|
@ -1814,7 +1814,7 @@ happens to be appropriate."
|
|||
Field names are wrapped in double quotes and equal signs are
|
||||
replaced with semicolons.
|
||||
|
||||
If FIX-KEY is non-nil, strip all \"FIX-KEY=\" occurences from
|
||||
If FIX-KEY is non-nil, strip all \"FIX-KEY=\" occurrences from
|
||||
partial output. This is used to get rid of useless keys in lists
|
||||
in MI messages, e.g.: [key=.., key=..]. -stack-list-frames and
|
||||
-break-info are examples of MI commands which issue such
|
||||
|
|
|
|||
|
|
@ -407,7 +407,7 @@ Always stores Fcc copy of message when nil."
|
|||
(if (memq system-type '(windows-nt ms-dos)) "-Ei" "-i")
|
||||
"String of options to use when running the program in `ispell-grep-command'.
|
||||
Should probably be \"-i\" or \"-e\".
|
||||
Some machines (like the NeXT) don't support \"-i\""
|
||||
Some machines (like the NeXT) don't support \"-i\"."
|
||||
:type 'string
|
||||
:group 'ispell)
|
||||
|
||||
|
|
@ -729,7 +729,7 @@ can be encoded as \\\"a, a\\\", \"a, ...) Defaults are ~tex and ~nroff
|
|||
in English. This has the same effect as the command-line `-T' option.
|
||||
The buffer Major Mode controls Ispell's parsing in tex or nroff mode,
|
||||
but the dictionary can control the extended character mode.
|
||||
Both defaults can be overruled in a buffer-local fashion. See
|
||||
Both defaults can be overruled in a buffer-local fashion. See
|
||||
`ispell-parsing-keyword' for details on this.
|
||||
|
||||
CHARACTER-SET used for languages with multibyte characters.
|
||||
|
|
@ -744,7 +744,7 @@ LANGUAGE.aff file \(e.g., english.aff\).")
|
|||
"Command line option prefix to select UTF-8 if supported, nil otherwise.
|
||||
If UTF-8 if supported by spellchecker and is selectable from the command line
|
||||
this variable will contain \"--encoding=\" for aspell and \"-i \" for hunspell,
|
||||
so UTF-8 or other mime charsets can be selected. That will be set for hunspell
|
||||
so UTF-8 or other mime charsets can be selected. That will be set for hunspell
|
||||
>=1.1.6 or aspell >= 0.60 in `ispell-check-version'.
|
||||
|
||||
For aspell non-nil means to try to automatically find aspell dictionaries.
|
||||
|
|
@ -752,9 +752,9 @@ Earlier aspell versions do not consistently support UTF-8. Handling
|
|||
this would require some extra guessing in `ispell-aspell-find-dictionary'.")
|
||||
|
||||
(defvar ispell-aspell-supports-utf8 nil
|
||||
"Non nil if aspell has consistent command line UTF-8 support. Obsolete.
|
||||
"Non nil if aspell has consistent command line UTF-8 support. Obsolete.
|
||||
ispell.el and flyspell.el will use for this purpose the more generic
|
||||
variable `ispell-encoding8-command' for both aspell and hunspell. Is left
|
||||
variable `ispell-encoding8-command' for both aspell and hunspell. Is left
|
||||
here just for backwards compatibility.")
|
||||
|
||||
(make-obsolete-variable 'ispell-aspell-supports-utf8
|
||||
|
|
@ -1048,7 +1048,7 @@ Return the new dictionary alist."
|
|||
;; Set params according to the selected spellchecker
|
||||
|
||||
(defvar ispell-last-program-name nil
|
||||
"Last value of `ispell-program-name'. Internal use.")
|
||||
"Last value of `ispell-program-name'. Internal use.")
|
||||
|
||||
(defvar ispell-initialize-spellchecker-hook nil
|
||||
"Normal hook run on spellchecker initialization.
|
||||
|
|
@ -1956,7 +1956,7 @@ Global `ispell-quit' set to start location to continue spell session."
|
|||
;; If the user types C-g, or generates some other
|
||||
;; non-character event (such as a frame switch
|
||||
;; event), stop ispell. As a special exception,
|
||||
;; ignore mouse events occuring in the same frame.
|
||||
;; ignore mouse events occurring in the same frame.
|
||||
(while (and input-valid (not (characterp char)))
|
||||
(setq char (read-key))
|
||||
(setq input-valid
|
||||
|
|
@ -2184,7 +2184,7 @@ SPC: Accept word this time.
|
|||
`a': Accept word for this session.
|
||||
`A': Accept word and place in `buffer-local dictionary'.
|
||||
`r': Replace word with typed-in value. Rechecked.
|
||||
`R': Replace word with typed-in value. Query-replaced in buffer. Rechecked.
|
||||
`R': Replace word with typed-in value. Query-replaced in buffer. Rechecked.
|
||||
`?': Show these commands.
|
||||
`x': Exit spelling buffer. Move cursor to original point.
|
||||
`X': Exit spelling buffer. Leaves cursor at the current point, and permits
|
||||
|
|
@ -2216,7 +2216,7 @@ SPC: Accept word this time.
|
|||
`a': Accept word for this session.
|
||||
`A': Accept word and place in `buffer-local dictionary'.
|
||||
`r': Replace word with typed-in value. Rechecked.
|
||||
`R': Replace word with typed-in value. Query-replaced in buffer. Rechecked.
|
||||
`R': Replace word with typed-in value. Query-replaced in buffer. Rechecked.
|
||||
`?': Show these commands.
|
||||
`x': Exit spelling buffer. Move cursor to original point.
|
||||
`X': Exit spelling buffer. Leaves cursor at the current point, and permits
|
||||
|
|
|
|||
|
|
@ -213,7 +213,7 @@ Only the value `maybe' can be trusted :-(."
|
|||
'names))))
|
||||
|
||||
(defun vc-arch-root (file)
|
||||
"Return the root directory of a Arch project, if any."
|
||||
"Return the root directory of an Arch project, if any."
|
||||
(or (vc-file-getprop file 'arch-root)
|
||||
;; Check the =tagging-method, in case someone naively manually
|
||||
;; creates a {arch} directory somewhere.
|
||||
|
|
|
|||
|
|
@ -77,9 +77,9 @@ WINDOW defaults to the selected window.
|
|||
|
||||
The return value does not include the mode line or the header
|
||||
line, if any. If a line at the bottom of the window is only
|
||||
partially visible, that line is included in the return value. If
|
||||
you do not want to include a partially visible bottom line in the
|
||||
return value, use `window-text-height' instead."
|
||||
partially visible, that line is included in the return value.
|
||||
If you do not want to include a partially visible bottom line
|
||||
in the return value, use `window-text-height' instead."
|
||||
(or window (setq window (selected-window)))
|
||||
(if (window-minibuffer-p window)
|
||||
(window-height window)
|
||||
|
|
@ -785,7 +785,7 @@ selected rather than \(as usual\) some other window. See
|
|||
|
||||
(defcustom pop-up-frames nil
|
||||
"Whether `display-buffer' should make a separate frame.
|
||||
If nil, never make a seperate frame.
|
||||
If nil, never make a separate frame.
|
||||
If the value is `graphic-only', make a separate frame
|
||||
on graphic displays only.
|
||||
Any other non-nil value means always make a separate frame."
|
||||
|
|
@ -1006,7 +1006,7 @@ is higher than WINDOW."
|
|||
(not (eq window (selected-window)))
|
||||
;; Don't resize minibuffer windows.
|
||||
(not (window-minibuffer-p (selected-window)))
|
||||
(> (window-height (selected-window)) (window-height window))
|
||||
(> (window-height (selected-window)) (window-height window))
|
||||
(eq (window-frame window) (window-frame (selected-window)))
|
||||
(let ((sel-edges (window-edges (selected-window)))
|
||||
(win-edges (window-edges window)))
|
||||
|
|
|
|||
|
|
@ -1,3 +1,9 @@
|
|||
2010-01-14 Juanma Barranquero <lekktu@gmail.com>
|
||||
|
||||
* cedet/cedet-utests.el (cedet-utest-log-shutdown, pulse-test):
|
||||
* cedet/semantic-ia-utest.el (semantic-ia-utest-error-log-list)
|
||||
(semantic-ia-utest-buffer-refs): Fix typos in docstrings.
|
||||
|
||||
2009-12-18 Ulf Jasper <ulf.jasper@web.de>
|
||||
|
||||
* icalendar-testsuite.el
|
||||
|
|
|
|||
|
|
@ -236,7 +236,7 @@ Argument START and END bound the time being calculated."
|
|||
(defun cedet-utest-log-shutdown (title &optional errorcondition)
|
||||
"Shut-down a larger test suite.
|
||||
TITLE is the section that is done.
|
||||
ERRORCONDITION is some error that may have occured durinig testing."
|
||||
ERRORCONDITION is some error that may have occurred during testing."
|
||||
(let ((endtime (current-time))
|
||||
)
|
||||
(cedet-utest-log-shutdown-msg title cedet-utest-log-timer endtime)
|
||||
|
|
@ -466,7 +466,7 @@ converted into.")
|
|||
|
||||
(defun pulse-test (&optional no-error)
|
||||
"Test the lightening function for pulsing a line.
|
||||
When optional NO-ERROR Don't throw an error if we can't run tests."
|
||||
When optional NO-ERROR don't throw an error if we can't run tests."
|
||||
(interactive)
|
||||
(if (or (not pulse-flag) (not (pulse-available-p)))
|
||||
(if no-error
|
||||
|
|
|
|||
|
|
@ -54,7 +54,7 @@
|
|||
"List of files with analyzer completion test points.")
|
||||
|
||||
(defvar semantic-ia-utest-error-log-list nil
|
||||
"List of errors occuring during a run.")
|
||||
"List of errors occurring during a run.")
|
||||
|
||||
;;;###autoload
|
||||
(defun semantic-ia-utest (&optional arg)
|
||||
|
|
@ -211,7 +211,7 @@ Argument ARG specifies which set of tests to run.
|
|||
))
|
||||
|
||||
(defun semantic-ia-utest-buffer-refs ()
|
||||
"Run a analyze-refs unit-test pass in the current buffer."
|
||||
"Run an analyze-refs unit-test pass in the current buffer."
|
||||
|
||||
(let* ((idx 1)
|
||||
(regex-p nil)
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue