Fix typos in docstrings.
* cus-edit.el (customize-apropos-options, custom-comment) (custom-comment-tag, custom-face-edit-attribute-tag): Fix typos in docstrings. (custom-buffer-done-kill): Remove * from defcustom docstring. (custom-file): Fix typo in doc of defcustom choice. * frame.el (display-visual-class): Fix typo in docstring. (initial-frame-alist, minibuffer-frame-alist, pop-up-frame-alist) (special-display-frame-alist, show-trailing-whitespace) (auto-hscroll-mode, blink-cursor-delay, blink-cursor-interval) (display-hourglass, hourglass-delay, cursor-in-non-selected-windows): Remove * from defcustom docstrings. * md4.el (md4-buffer): Fix typo in docstring. (md4, md4-64): Doc fixes. (md4-pack-int32): Reflow docstring. * paths.el (rmail-file-name): Remove * from defcustom docstring. (prune-directory-list, gnus-nntp-service): Fix typos in docstrings. * rect.el (open-rectangle): Reflow docstring. (spaces-string): Fix docstring typo. Use "?\s" instead of "? ". * select.el (x-get-cut-buffer): Fix typo in docstring. * timezone.el (timezone-zone-to-minute, timezone-time-from-absolute) (timezone-time-zone-from-absolute, timezone-leap-year-p): Fix typos in docstrings. * emacs-lisp/assoc.el (asort, aelement, aput, aget, amake): Fix typos in docstrings.
This commit is contained in:
parent
322ca65006
commit
6cda144ffe
9 changed files with 85 additions and 48 deletions
|
@ -1,3 +1,37 @@
|
|||
2008-11-01 Juanma Barranquero <lekktu@gmail.com>
|
||||
|
||||
* cus-edit.el (customize-apropos-options, custom-comment)
|
||||
(custom-comment-tag, custom-face-edit-attribute-tag):
|
||||
Fix typos in docstrings.
|
||||
(custom-buffer-done-kill): Remove * from defcustom docstring.
|
||||
(custom-file): Fix typo in doc of defcustom choice.
|
||||
|
||||
* frame.el (display-visual-class): Fix typo in docstring.
|
||||
(initial-frame-alist, minibuffer-frame-alist, pop-up-frame-alist)
|
||||
(special-display-frame-alist, show-trailing-whitespace)
|
||||
(auto-hscroll-mode, blink-cursor-delay, blink-cursor-interval)
|
||||
(display-hourglass, hourglass-delay, cursor-in-non-selected-windows):
|
||||
Remove * from defcustom docstrings.
|
||||
|
||||
* md4.el (md4-buffer): Fix typo in docstring.
|
||||
(md4, md4-64): Doc fixes.
|
||||
(md4-pack-int32): Reflow docstring.
|
||||
|
||||
* paths.el (rmail-file-name): Remove * from defcustom docstring.
|
||||
(prune-directory-list, gnus-nntp-service): Fix typos in docstrings.
|
||||
|
||||
* rect.el (open-rectangle): Reflow docstring.
|
||||
(spaces-string): Fix docstring typo. Use "?\s" instead of "? ".
|
||||
|
||||
* select.el (x-get-cut-buffer): Fix typo in docstring.
|
||||
|
||||
* timezone.el (timezone-zone-to-minute, timezone-time-from-absolute)
|
||||
(timezone-time-zone-from-absolute, timezone-leap-year-p):
|
||||
Fix typos in docstrings.
|
||||
|
||||
* emacs-lisp/assoc.el (asort, aelement, aput, aget, amake):
|
||||
Fix typos in docstrings.
|
||||
|
||||
2008-10-31 Ulf Jasper <ulf.jasper@web.de>
|
||||
|
||||
* net/newst-backend.el (newsticker--cache-update): Fix no-save case.
|
||||
|
|
|
@ -1426,7 +1426,7 @@ that are not customizable options, as well as faces and groups
|
|||
;;;###autoload
|
||||
(defun customize-apropos-options (regexp &optional arg)
|
||||
"Customize all loaded customizable options matching REGEXP.
|
||||
With prefix arg, include variables that are not customizable options
|
||||
With prefix ARG, include variables that are not customizable options
|
||||
\(but it is better to use `apropos-variable' if you want to find those)."
|
||||
(interactive "sCustomize options (regexp): \nP")
|
||||
(customize-apropos regexp (or arg 'options)))
|
||||
|
@ -1456,7 +1456,7 @@ links: groups have links to subgroups."
|
|||
:group 'custom-buffer)
|
||||
|
||||
(defcustom custom-buffer-done-kill nil
|
||||
"*Non-nil means exiting a Custom buffer should kill it."
|
||||
"Non-nil means exiting a Custom buffer should kill it."
|
||||
:type 'boolean
|
||||
:version "22.1"
|
||||
:group 'custom-buffer)
|
||||
|
@ -2363,7 +2363,7 @@ If INITIAL-STRING is non-nil, use that rather than \"Parent groups:\"."
|
|||
:background "dim gray")
|
||||
(t
|
||||
:slant italic))
|
||||
"Face used for comments on variables or faces"
|
||||
"Face used for comments on variables or faces."
|
||||
:version "21.1"
|
||||
:group 'custom-faces)
|
||||
;; backward-compatibility alias
|
||||
|
@ -2378,7 +2378,7 @@ If INITIAL-STRING is non-nil, use that rather than \"Parent groups:\"."
|
|||
(((class grayscale) (background dark))
|
||||
(:foreground "LightGray" :weight bold :slant italic))
|
||||
(t (:weight bold)))
|
||||
"Face used for variables or faces comment tags"
|
||||
"Face used for variables or faces comment tags."
|
||||
:group 'custom-faces)
|
||||
;; backward-compatibility alias
|
||||
(put 'custom-comment-tag-face 'face-alias 'custom-comment-tag)
|
||||
|
@ -3115,7 +3115,7 @@ Also change :reverse-video to :inverse-video."
|
|||
|
||||
|
||||
(defun custom-face-edit-attribute-tag (widget)
|
||||
"Returns the first :tag property in WIDGET or one of its children."
|
||||
"Return the first :tag property in WIDGET or one of its children."
|
||||
(let ((tag (widget-get widget :tag)))
|
||||
(or (and (not (equal tag "")) tag)
|
||||
(let ((children (widget-get widget :children)))
|
||||
|
@ -4230,7 +4230,7 @@ and hence will not set `custom-file' to that file either."
|
|||
:doc
|
||||
"Please read entire docstring below before setting \
|
||||
this through Custom.
|
||||
Click om \"More\" \(or position point there and press RETURN)
|
||||
Click on \"More\" \(or position point there and press RETURN)
|
||||
if only the first line of the docstring is shown."))
|
||||
:group 'customize)
|
||||
|
||||
|
|
|
@ -30,7 +30,7 @@
|
|||
|
||||
(defun asort (alist-symbol key)
|
||||
"Move a specified key-value pair to the head of an alist.
|
||||
The alist is referenced by ALIST-SYMBOL. Key-value pair to move to
|
||||
The alist is referenced by ALIST-SYMBOL. Key-value pair to move to
|
||||
head is one matching KEY. Returns the sorted list and doesn't affect
|
||||
the order of any other key-value pair. Side effect sets alist to new
|
||||
sorted list."
|
||||
|
@ -40,7 +40,7 @@ sorted list."
|
|||
|
||||
|
||||
(defun aelement (key value)
|
||||
"Makes a list of a cons cell containing car of KEY and cdr of VALUE.
|
||||
"Make a list of a cons cell containing car of KEY and cdr of VALUE.
|
||||
The returned list is suitable as an element of an alist."
|
||||
(list (cons key value)))
|
||||
|
||||
|
@ -61,14 +61,14 @@ pair is not at the head of alist. ALIST is not altered."
|
|||
|
||||
(defun aput (alist-symbol key &optional value)
|
||||
"Inserts a key-value pair into an alist.
|
||||
The alist is referenced by ALIST-SYMBOL. The key-value pair is made
|
||||
from KEY and optionally, VALUE. Returns the altered alist or nil if
|
||||
The alist is referenced by ALIST-SYMBOL. The key-value pair is made
|
||||
from KEY and optionally, VALUE. Returns the altered alist or nil if
|
||||
ALIST is nil.
|
||||
|
||||
If the key-value pair referenced by KEY can be found in the alist, and
|
||||
VALUE is supplied non-nil, then the value of KEY will be set to VALUE.
|
||||
If VALUE is not supplied, or is nil, the key-value pair will not be
|
||||
modified, but will be moved to the head of the alist. If the key-value
|
||||
modified, but will be moved to the head of the alist. If the key-value
|
||||
pair cannot be found in the alist, it will be inserted into the head
|
||||
of the alist (with value nil if VALUE is nil or not supplied)."
|
||||
(let ((elem (aelement key value))
|
||||
|
@ -93,14 +93,14 @@ is pair matching KEY. Returns the altered alist."
|
|||
|
||||
|
||||
(defun aget (alist key &optional keynil-p)
|
||||
"Returns the value in ALIST that is associated with KEY.
|
||||
"Return the value in ALIST that is associated with KEY.
|
||||
Optional KEYNIL-P describes what to do if the value associated with
|
||||
KEY is nil. If KEYNIL-P is not supplied or is nil, and the value is
|
||||
nil, then KEY is returned. If KEYNIL-P is non-nil, then nil would be
|
||||
returned.
|
||||
|
||||
If no key-value pair matching KEY could be found in ALIST, or ALIST is
|
||||
nil then nil is returned. ALIST is not altered."
|
||||
nil then nil is returned. ALIST is not altered."
|
||||
(let ((copy (copy-alist alist)))
|
||||
(cond ((null alist) nil)
|
||||
((progn (asort 'copy key)
|
||||
|
@ -114,8 +114,8 @@ nil then nil is returned. ALIST is not altered."
|
|||
(defun amake (alist-symbol keylist &optional valuelist)
|
||||
"Make an association list.
|
||||
The association list is attached to the alist referenced by
|
||||
ALIST-SYMBOL. Each element in the KEYLIST becomes a key and is
|
||||
associated with the value in VALUELIST with the same index. If
|
||||
ALIST-SYMBOL. Each element in the KEYLIST becomes a key and is
|
||||
associated with the value in VALUELIST with the same index. If
|
||||
VALUELIST is not supplied or is nil, then each key in KEYLIST is
|
||||
associated with nil.
|
||||
|
||||
|
|
|
@ -51,7 +51,7 @@ Parameters specified here supersede the values given in `default-frame-alist'.")
|
|||
;; But that's not necessary, because the default is to have one.
|
||||
;; By not specifying it here, we let an X resource specify it.
|
||||
(defcustom initial-frame-alist nil
|
||||
"*Alist of frame parameters for creating the initial X window frame.
|
||||
"Alist of frame parameters for creating the initial X window frame.
|
||||
You can set this in your `.emacs' file; for example,
|
||||
(setq initial-frame-alist '((top . 1) (left . 1) (width . 80) (height . 55)))
|
||||
Parameters specified here supersede the values given in `default-frame-alist'.
|
||||
|
@ -76,7 +76,7 @@ as it appears, you need to use this three-step process:
|
|||
:group 'frames)
|
||||
|
||||
(defcustom minibuffer-frame-alist '((width . 80) (height . 2))
|
||||
"*Alist of frame parameters for initially creating a minibuffer frame.
|
||||
"Alist of frame parameters for initially creating a minibuffer frame.
|
||||
You can set this in your `.emacs' file; for example,
|
||||
(setq minibuffer-frame-alist
|
||||
'((top . 1) (left . 1) (width . 80) (height . 2)))
|
||||
|
@ -88,7 +88,7 @@ Parameters specified here supersede the values given in
|
|||
:group 'frames)
|
||||
|
||||
(defcustom pop-up-frame-alist nil
|
||||
"*Alist of frame parameters used when creating pop-up frames.
|
||||
"Alist of frame parameters used when creating pop-up frames.
|
||||
Pop-up frames are used for completions, help, and the like.
|
||||
This variable can be set in your init file, like this:
|
||||
(setq pop-up-frame-alist '((width . 80) (height . 20)))
|
||||
|
@ -108,7 +108,7 @@ It is called with no arguments and should return a newly created frame."
|
|||
|
||||
(defcustom special-display-frame-alist
|
||||
'((height . 14) (width . 80) (unsplittable . t))
|
||||
"*Alist of frame parameters used when creating special frames.
|
||||
"Alist of frame parameters used when creating special frames.
|
||||
Special frames are used for buffers whose names are in
|
||||
`special-display-buffer-names' and for buffers whose names match
|
||||
one of the regular expressions in `special-display-regexps'.
|
||||
|
@ -1107,7 +1107,7 @@ To get the frame's current border color, use `frame-parameters'."
|
|||
|
||||
(defun auto-raise-mode (arg)
|
||||
"Toggle whether or not the selected frame should auto-raise.
|
||||
With arg, turn auto-raise mode on if and only if arg is positive.
|
||||
With ARG, turn auto-raise mode on if and only if ARG is positive.
|
||||
Note that this controls Emacs's own auto-raise feature.
|
||||
Some window managers allow you to enable auto-raise for certain windows.
|
||||
You can use that for Emacs windows if you wish, but if you do,
|
||||
|
@ -1124,7 +1124,7 @@ that is beyond the control of Emacs and this command has no effect on it."
|
|||
|
||||
(defun auto-lower-mode (arg)
|
||||
"Toggle whether or not the selected frame should auto-lower.
|
||||
With arg, turn auto-lower mode on if and only if arg is positive.
|
||||
With ARG, turn auto-lower mode on if and only if ARG is positive.
|
||||
Note that this controls Emacs's own auto-lower feature.
|
||||
Some window managers allow you to enable auto-lower for certain windows.
|
||||
You can use that for Emacs windows if you wish, but if you do,
|
||||
|
@ -1364,7 +1364,7 @@ the question is inapplicable to a certain kind of display."
|
|||
(declare-function x-display-visual-class "xfns.c" (&optional terminal))
|
||||
|
||||
(defun display-visual-class (&optional display)
|
||||
"Returns the visual class of DISPLAY.
|
||||
"Return the visual class of DISPLAY.
|
||||
The value is one of the symbols `static-gray', `gray-scale',
|
||||
`static-color', `pseudo-color', `true-color', or `direct-color'."
|
||||
(let ((frame-type (framep-on-display display)))
|
||||
|
@ -1491,7 +1491,7 @@ left untouched. FRAME nil or omitted means use the selected frame."
|
|||
(make-variable-buffer-local 'show-trailing-whitespace)
|
||||
|
||||
(defcustom show-trailing-whitespace nil
|
||||
"*Non-nil means highlight trailing whitespace.
|
||||
"Non-nil means highlight trailing whitespace.
|
||||
This is done in the face `trailing-whitespace'."
|
||||
:type 'boolean
|
||||
:group 'whitespace-faces)
|
||||
|
@ -1506,7 +1506,7 @@ This is done in the face `trailing-whitespace'."
|
|||
:group 'frames)
|
||||
|
||||
(defcustom auto-hscroll-mode t
|
||||
"*Allow or disallow automatic scrolling windows horizontally.
|
||||
"Allow or disallow automatic scrolling windows horizontally.
|
||||
If non-nil, windows are automatically scrolled horizontally to make
|
||||
point visible."
|
||||
:version "21.1"
|
||||
|
@ -1523,12 +1523,12 @@ point visible."
|
|||
:group 'frames)
|
||||
|
||||
(defcustom blink-cursor-delay 0.5
|
||||
"*Seconds of idle time after which cursor starts to blink."
|
||||
"Seconds of idle time after which cursor starts to blink."
|
||||
:type 'number
|
||||
:group 'cursor)
|
||||
|
||||
(defcustom blink-cursor-interval 0.5
|
||||
"*Length of cursor blink interval in seconds."
|
||||
"Length of cursor blink interval in seconds."
|
||||
:type 'number
|
||||
:group 'cursor)
|
||||
|
||||
|
@ -1602,20 +1602,20 @@ cursor display. On a text-only terminal, this is not implemented."
|
|||
;; Hourglass pointer
|
||||
|
||||
(defcustom display-hourglass t
|
||||
"*Non-nil means show an hourglass pointer, when Emacs is busy.
|
||||
"Non-nil means show an hourglass pointer, when Emacs is busy.
|
||||
This feature only works when on a window system that can change
|
||||
cursor shapes."
|
||||
:type 'boolean
|
||||
:group 'cursor)
|
||||
|
||||
(defcustom hourglass-delay 1
|
||||
"*Seconds to wait before displaying an hourglass pointer when Emacs is busy."
|
||||
"Seconds to wait before displaying an hourglass pointer when Emacs is busy."
|
||||
:type 'number
|
||||
:group 'cursor)
|
||||
|
||||
|
||||
(defcustom cursor-in-non-selected-windows t
|
||||
"*Non-nil means show a hollow box cursor in non-selected windows.
|
||||
"Non-nil means show a hollow box cursor in non-selected windows.
|
||||
If nil, don't show a cursor except in the selected window.
|
||||
If t, display a cursor related to the usual cursor type
|
||||
\(a solid box becomes hollow, a bar becomes a narrower bar).
|
||||
|
|
17
lisp/md4.el
17
lisp/md4.el
|
@ -28,11 +28,12 @@
|
|||
;;; MD4 hash calculation
|
||||
|
||||
(defvar md4-buffer (make-vector 4 '(0 . 0))
|
||||
"work buffer of four 32-bit integers")
|
||||
"Work buffer of four 32-bit integers.")
|
||||
|
||||
(defun md4 (in n)
|
||||
"Returns the MD4 hash string of 16 bytes long for a string IN of N
|
||||
bytes long. N is required to handle strings containing character 0."
|
||||
"Return the MD4 hash for a string IN of length N bytes.
|
||||
The returned hash is 16 bytes long. N is required to handle
|
||||
strings containing the character 0."
|
||||
(let (m
|
||||
(b (cons 0 (* n 8)))
|
||||
(i 0)
|
||||
|
@ -115,8 +116,9 @@ bytes long. N is required to handle strings containing character 0."
|
|||
(cons (logand (car x) (car y)) (logand (cdr x) (cdr y))))
|
||||
|
||||
(defun md4-64 (m)
|
||||
"Calculate md4 of 64 bytes chunk M which is represented as 16 pairs of
|
||||
32 bits integers. The resulting md4 value is placed in md4-buffer."
|
||||
"Calculate MD4 hash of M.
|
||||
M is a 64-bytes chunk, represented as 16 pairs of 32-bit integers.
|
||||
The resulting MD4 value is placed in `md4-buffer'."
|
||||
(let ((a (aref md4-buffer 0))
|
||||
(b (aref md4-buffer 1))
|
||||
(c (aref md4-buffer 2))
|
||||
|
@ -199,8 +201,9 @@ bytes long. N is required to handle strings containing character 0."
|
|||
str))
|
||||
|
||||
(defun md4-pack-int32 (int32)
|
||||
"Pack 32 bits integer in a 4 bytes string as little endian. A 32 bits
|
||||
integer is represented as a pair of two 16 bits integers (cons high low)."
|
||||
"Pack 32 bits integer in a 4 bytes string as little endian.
|
||||
A 32 bits integer is represented as a pair of two 16 bits
|
||||
integers (cons high low)."
|
||||
(let ((str (make-string 4 0))
|
||||
(h (car int32)) (l (cdr int32)))
|
||||
(aset str 0 (logand l 255))
|
||||
|
|
|
@ -36,7 +36,7 @@
|
|||
;; DOC file rather than in memory.
|
||||
|
||||
(defun prune-directory-list (dirs &optional keep reject)
|
||||
"Returns a copy of DIRS with all non-existent directories removed.
|
||||
"Return a copy of DIRS with all non-existent directories removed.
|
||||
The optional argument KEEP is a list of directories to retain even if
|
||||
they don't exist, and REJECT is a list of directories to remove from
|
||||
DIRS, even if they exist; REJECT takes precedence over KEEP.
|
||||
|
@ -122,7 +122,7 @@ The name of the host running an NNTP server.
|
|||
The null string means use the local host as the server site.")
|
||||
|
||||
(defvar gnus-nntp-service "nntp"
|
||||
"NNTP service name, usually \"nntp\" or 119).
|
||||
"NNTP service name, usually \"nntp\" or 119.
|
||||
Go to a local news spool if its value is nil, in which case `gnus-nntp-server'
|
||||
should be set to `(system-name)'.")
|
||||
|
||||
|
@ -131,7 +131,7 @@ should be set to `(system-name)'.")
|
|||
The `ORGANIZATION' environment variable is used instead if defined.")
|
||||
|
||||
(defcustom rmail-file-name "~/RMAIL"
|
||||
"*Name of user's primary mail file."
|
||||
"Name of user's primary mail file."
|
||||
:type 'string
|
||||
:group 'rmail
|
||||
:version "21.1")
|
||||
|
|
|
@ -187,9 +187,9 @@ the function is called."
|
|||
|
||||
;; this one is untouched --dv
|
||||
(defun spaces-string (n)
|
||||
"Returns a string with N spaces."
|
||||
"Return a string with N spaces."
|
||||
(if (<= n 8) (aref spaces-strings n)
|
||||
(make-string n ? )))
|
||||
(make-string n ?\s)))
|
||||
|
||||
;;;###autoload
|
||||
(defun delete-rectangle (start end &optional fill)
|
||||
|
@ -290,8 +290,8 @@ The text previously in the region is not overwritten by the blanks,
|
|||
but instead winds up to the right of the rectangle.
|
||||
|
||||
When called from a program the rectangle's corners are START and END.
|
||||
With a prefix (or a FILL) argument, fill with blanks even if there is no text
|
||||
on the right side of the rectangle."
|
||||
With a prefix (or a FILL) argument, fill with blanks even if there is
|
||||
no text on the right side of the rectangle."
|
||||
(interactive "*r\nP")
|
||||
(apply-on-rectangle 'open-rectangle-line start end fill)
|
||||
(goto-char start))
|
||||
|
|
|
@ -182,7 +182,7 @@ prefix argument, it uses the text of the region as the selection value ."
|
|||
(declare-function x-get-cut-buffer-internal "xselect.c")
|
||||
|
||||
(defun x-get-cut-buffer (&optional which-one)
|
||||
"Returns the value of one of the 8 X server cut-buffers.
|
||||
"Return the value of one of the 8 X server cut-buffers.
|
||||
Optional arg WHICH-ONE should be a number from 0 to 7, defaulting to 0.
|
||||
Cut buffers are considered obsolete; you should use selections instead."
|
||||
(x-get-cut-buffer-internal
|
||||
|
|
|
@ -258,7 +258,7 @@ Recognize HH:MM:SS, HH:MM, HHMMSS, HHMM."
|
|||
|
||||
(defun timezone-zone-to-minute (timezone)
|
||||
"Translate TIMEZONE to an integer minute offset from GMT.
|
||||
TIMEZONE can be a cons cell containing the output of current-time-zone,
|
||||
TIMEZONE can be a cons cell containing the output of `current-time-zone',
|
||||
or an integer of the form +-HHMM, or a time zone name."
|
||||
(cond
|
||||
((consp timezone)
|
||||
|
@ -280,7 +280,7 @@ or an integer of the form +-HHMM, or a time zone name."
|
|||
|
||||
(defun timezone-time-from-absolute (date seconds)
|
||||
"Compute the UTC time equivalent to DATE at time SECONDS after midnight.
|
||||
Return a list suitable as an argument to current-time-zone,
|
||||
Return a list suitable as an argument to `current-time-zone',
|
||||
or nil if the date cannot be thus represented.
|
||||
DATE is the number of days elapsed since the (imaginary)
|
||||
Gregorian date Sunday, December 31, 1 BC."
|
||||
|
@ -298,7 +298,7 @@ Gregorian date Sunday, December 31, 1 BC."
|
|||
|
||||
(defun timezone-time-zone-from-absolute (date seconds)
|
||||
"Compute the local time zone for DATE at time SECONDS after midnight.
|
||||
Return a list in the same format as current-time-zone's result,
|
||||
Return a list in the same format as `current-time-zone's result,
|
||||
or nil if the local time zone could not be computed.
|
||||
DATE is the number of days elapsed since the (imaginary)
|
||||
Gregorian date Sunday, December 31, 1 BC."
|
||||
|
@ -370,7 +370,7 @@ If TIMEZONE is nil, use the local time zone."
|
|||
(aref [31 28 31 30 31 30 31 31 30 31 30 31] (1- month))))
|
||||
|
||||
(defun timezone-leap-year-p (year)
|
||||
"Returns t if YEAR is a Gregorian leap year."
|
||||
"Return t if YEAR is a Gregorian leap year."
|
||||
(or (and (zerop (% year 4))
|
||||
(not (zerop (% year 100))))
|
||||
(zerop (% year 400))))
|
||||
|
|
Loading…
Add table
Reference in a new issue