mirror of
git://git.sv.gnu.org/emacs.git
synced 2025-12-21 05:00:47 -08:00
; Fix some typos in doc strings and manuals
This commit is contained in:
parent
af464e4380
commit
2c2dfbbbf0
12 changed files with 23 additions and 23 deletions
|
|
@ -486,7 +486,7 @@ variable with the same name as one of the macro arguments. Inside the
|
||||||
macro body, the macro argument binding is the most local binding of this
|
macro body, the macro argument binding is the most local binding of this
|
||||||
variable, so any references inside the form being evaluated do refer to
|
variable, so any references inside the form being evaluated do refer to
|
||||||
it. Here is an example:
|
it. Here is an example:
|
||||||
|
@c FIXME with lexical-binding t this example no longer applies
|
||||||
@example
|
@example
|
||||||
@group
|
@group
|
||||||
(defmacro foo (a)
|
(defmacro foo (a)
|
||||||
|
|
|
||||||
|
|
@ -301,7 +301,7 @@ character, and returns that character. If @var{char} is neither
|
||||||
@end defun
|
@end defun
|
||||||
|
|
||||||
@defun unibyte-char-to-multibyte char
|
@defun unibyte-char-to-multibyte char
|
||||||
This convert the unibyte character @var{char} to a multibyte
|
This converts the unibyte character @var{char} to a multibyte
|
||||||
character, assuming @var{char} is either @acronym{ASCII} or raw 8-bit
|
character, assuming @var{char} is either @acronym{ASCII} or raw 8-bit
|
||||||
byte.
|
byte.
|
||||||
@end defun
|
@end defun
|
||||||
|
|
@ -676,7 +676,7 @@ This function returns the value of @var{char}'s @var{propname} property.
|
||||||
@end group
|
@end group
|
||||||
@group
|
@group
|
||||||
(get-char-code-property ?\( 'paired-bracket)
|
(get-char-code-property ?\( 'paired-bracket)
|
||||||
@result{} 41 ;; closing parenthesis
|
@result{} 41 ; closing parenthesis
|
||||||
@end group
|
@end group
|
||||||
@group
|
@group
|
||||||
(get-char-code-property ?\) 'bracket-type)
|
(get-char-code-property ?\) 'bracket-type)
|
||||||
|
|
@ -955,13 +955,13 @@ translating the result.
|
||||||
|
|
||||||
@defvar standard-translation-table-for-decode
|
@defvar standard-translation-table-for-decode
|
||||||
This is the default translation table for decoding. If a coding
|
This is the default translation table for decoding. If a coding
|
||||||
systems specifies its own translation tables, the table that is the
|
system specifies its own translation tables, the table that is the
|
||||||
value of this variable, if non-@code{nil}, is applied after them.
|
value of this variable, if non-@code{nil}, is applied after them.
|
||||||
@end defvar
|
@end defvar
|
||||||
|
|
||||||
@defvar standard-translation-table-for-encode
|
@defvar standard-translation-table-for-encode
|
||||||
This is the default translation table for encoding. If a coding
|
This is the default translation table for encoding. If a coding
|
||||||
systems specifies its own translation tables, the table that is the
|
system specifies its own translation tables, the table that is the
|
||||||
value of this variable, if non-@code{nil}, is applied after them.
|
value of this variable, if non-@code{nil}, is applied after them.
|
||||||
@end defvar
|
@end defvar
|
||||||
|
|
||||||
|
|
@ -1258,7 +1258,7 @@ name or @code{nil}.
|
||||||
@defun check-coding-system coding-system
|
@defun check-coding-system coding-system
|
||||||
This function checks the validity of @var{coding-system}. If that is
|
This function checks the validity of @var{coding-system}. If that is
|
||||||
valid, it returns @var{coding-system}. If @var{coding-system} is
|
valid, it returns @var{coding-system}. If @var{coding-system} is
|
||||||
@code{nil}, the function return @code{nil}. For any other values, it
|
@code{nil}, the function returns @code{nil}. For any other values, it
|
||||||
signals an error whose @code{error-symbol} is @code{coding-system-error}
|
signals an error whose @code{error-symbol} is @code{coding-system-error}
|
||||||
(@pxref{Signaling Errors, signal}).
|
(@pxref{Signaling Errors, signal}).
|
||||||
@end defun
|
@end defun
|
||||||
|
|
|
||||||
|
|
@ -17966,7 +17966,7 @@ This creates a group including all flagged messages from all groups on
|
||||||
two IMAP servers, "home" and "work".
|
two IMAP servers, "home" and "work".
|
||||||
|
|
||||||
And one last example. Here is a function that runs a search query to
|
And one last example. Here is a function that runs a search query to
|
||||||
find all message that have been received recently from certain groups:
|
find all messages that have been received recently from certain groups:
|
||||||
|
|
||||||
@lisp
|
@lisp
|
||||||
(defun my-recent-email (args)
|
(defun my-recent-email (args)
|
||||||
|
|
|
||||||
2
etc/NEWS
2
etc/NEWS
|
|
@ -1684,7 +1684,7 @@ to the 'project-root' of the current project, when available.
|
||||||
*** The TAB key binding in *xref* buffers is obsolete.
|
*** The TAB key binding in *xref* buffers is obsolete.
|
||||||
Use 'C-u RET' instead. The TAB binding in *xref* buffers is still
|
Use 'C-u RET' instead. The TAB binding in *xref* buffers is still
|
||||||
supported, but we plan on removing it in a future version; at that
|
supported, but we plan on removing it in a future version; at that
|
||||||
time, the command 'xref-quit-and-got-xref' will no longer have a key
|
time, the command 'xref-quit-and-goto-xref' will no longer have a key
|
||||||
binding in 'xref--xref-buffer-mode-map'.
|
binding in 'xref--xref-buffer-mode-map'.
|
||||||
|
|
||||||
** json.el
|
** json.el
|
||||||
|
|
|
||||||
|
|
@ -438,7 +438,7 @@ Presumes point is at the end of the `cl-defmethod' symbol."
|
||||||
;;;###autoload
|
;;;###autoload
|
||||||
(defmacro cl-defmethod (name args &rest body)
|
(defmacro cl-defmethod (name args &rest body)
|
||||||
"Define a new method for generic function NAME.
|
"Define a new method for generic function NAME.
|
||||||
This it defines an implementation of NAME to use for invocations
|
This defines an implementation of NAME to use for invocations
|
||||||
of specific types of arguments.
|
of specific types of arguments.
|
||||||
|
|
||||||
ARGS is a list of dispatch arguments (see `cl-defun'), but where
|
ARGS is a list of dispatch arguments (see `cl-defun'), but where
|
||||||
|
|
|
||||||
|
|
@ -63,7 +63,7 @@ If this variable is set to 0, no idle time is required."
|
||||||
:type 'number)
|
:type 'number)
|
||||||
|
|
||||||
(defcustom eldoc-print-after-edit nil
|
(defcustom eldoc-print-after-edit nil
|
||||||
"If non-nil eldoc info is only shown when editing.
|
"If non-nil, eldoc info is only shown when editing.
|
||||||
Changing the value requires toggling `eldoc-mode'."
|
Changing the value requires toggling `eldoc-mode'."
|
||||||
:type 'boolean)
|
:type 'boolean)
|
||||||
|
|
||||||
|
|
@ -391,12 +391,12 @@ name, inside its arg list, or on any object with some associated
|
||||||
information.
|
information.
|
||||||
|
|
||||||
Each hook function is called with at least one argument CALLBACK,
|
Each hook function is called with at least one argument CALLBACK,
|
||||||
a function, and decides whether to display a doc short string
|
a function, and decides whether to display a short doc string
|
||||||
about the context around point.
|
about the context around point.
|
||||||
|
|
||||||
- If that decision can be taken quickly, the hook function may
|
- If that decision can be taken quickly, the hook function may
|
||||||
call CALLBACK immediately following the protocol described
|
call CALLBACK immediately, following the protocol described
|
||||||
below. Alternatively it may ignore CALLBACK entirely and
|
below. Alternatively, it may ignore CALLBACK entirely and
|
||||||
return either the doc string, or nil if there's no doc
|
return either the doc string, or nil if there's no doc
|
||||||
appropriate for the context.
|
appropriate for the context.
|
||||||
|
|
||||||
|
|
@ -688,11 +688,11 @@ following values are allowed:
|
||||||
- `eldoc-documentation-compose': calls all functions in the
|
- `eldoc-documentation-compose': calls all functions in the
|
||||||
special hook and displays all of the resulting doc strings
|
special hook and displays all of the resulting doc strings
|
||||||
together. Wait for all strings to be ready, and preserve their
|
together. Wait for all strings to be ready, and preserve their
|
||||||
relative as specified by the order of functions in the hook;
|
relative order as specified by the order of functions in the hook;
|
||||||
|
|
||||||
- `eldoc-documentation-compose-eagerly': calls all functions in
|
- `eldoc-documentation-compose-eagerly': calls all functions in
|
||||||
the special hook and display as many of the resulting doc
|
the special hook and displays as many of the resulting doc
|
||||||
strings as possible, as soon as possible. Preserving the
|
strings as possible, as soon as possible. Preserves the
|
||||||
relative order of doc strings;
|
relative order of doc strings;
|
||||||
|
|
||||||
- `eldoc-documentation-enthusiast': calls all functions in the
|
- `eldoc-documentation-enthusiast': calls all functions in the
|
||||||
|
|
@ -793,7 +793,7 @@ function passes responsibility to the functions in
|
||||||
Other third-party values of `eldoc-documentation-strategy' should
|
Other third-party values of `eldoc-documentation-strategy' should
|
||||||
not use `eldoc--make-callback'. They must find some alternate
|
not use `eldoc--make-callback'. They must find some alternate
|
||||||
way to produce callbacks to feed to
|
way to produce callbacks to feed to
|
||||||
`eldoc-documentation-function' and should endeavour to display
|
`eldoc-documentation-functions' and should endeavour to display
|
||||||
the docstrings eventually produced, using
|
the docstrings eventually produced, using
|
||||||
`eldoc-display-functions'."
|
`eldoc-display-functions'."
|
||||||
(let* (;; How many callbacks have been created by the strategy
|
(let* (;; How many callbacks have been created by the strategy
|
||||||
|
|
|
||||||
|
|
@ -1210,7 +1210,7 @@ unmatchable Never match anything at all.
|
||||||
CHARCLASS Match a character from a character class. One of:
|
CHARCLASS Match a character from a character class. One of:
|
||||||
alpha, alphabetic, letter Alphabetic characters (defined by Unicode).
|
alpha, alphabetic, letter Alphabetic characters (defined by Unicode).
|
||||||
alnum, alphanumeric Alphabetic or decimal digit chars (Unicode).
|
alnum, alphanumeric Alphabetic or decimal digit chars (Unicode).
|
||||||
digit numeric, num 0-9.
|
digit, numeric, num 0-9.
|
||||||
xdigit, hex-digit, hex 0-9, A-F, a-f.
|
xdigit, hex-digit, hex 0-9, A-F, a-f.
|
||||||
cntrl, control ASCII codes 0-31.
|
cntrl, control ASCII codes 0-31.
|
||||||
blank Horizontal whitespace (Unicode).
|
blank Horizontal whitespace (Unicode).
|
||||||
|
|
|
||||||
|
|
@ -8089,7 +8089,7 @@ Return nil if there are no unseen articles."
|
||||||
|
|
||||||
(defun gnus-summary-first-unseen-or-unread-subject ()
|
(defun gnus-summary-first-unseen-or-unread-subject ()
|
||||||
"Place the point on the subject line of the first unseen and unread article.
|
"Place the point on the subject line of the first unseen and unread article.
|
||||||
If all article have been seen, on the subject line of the first unread
|
If all articles have been seen, on the subject line of the first unread
|
||||||
article."
|
article."
|
||||||
(interactive nil gnus-summary-mode)
|
(interactive nil gnus-summary-mode)
|
||||||
(prog1
|
(prog1
|
||||||
|
|
|
||||||
|
|
@ -374,7 +374,7 @@ in this way.
|
||||||
If DONT-OVERRIDE is t, style variables that already have values (i.e., whose
|
If DONT-OVERRIDE is t, style variables that already have values (i.e., whose
|
||||||
values are not the symbol `set-from-style') will not be overridden. CC Mode
|
values are not the symbol `set-from-style') will not be overridden. CC Mode
|
||||||
calls c-set-style internally in this way whilst initializing a buffer; if
|
calls c-set-style internally in this way whilst initializing a buffer; if
|
||||||
cc-set-style is called like this from anywhere else, it will usually behave as
|
c-set-style is called like this from anywhere else, it will usually behave as
|
||||||
a null operation."
|
a null operation."
|
||||||
(interactive
|
(interactive
|
||||||
(list (let ((completion-ignore-case t)
|
(list (let ((completion-ignore-case t)
|
||||||
|
|
|
||||||
|
|
@ -77,7 +77,7 @@ Detection of repeated words is not implemented in
|
||||||
"A list of exceptions for duplicated words.
|
"A list of exceptions for duplicated words.
|
||||||
It should be a list of (LANGUAGE . EXCEPTION-LIST).
|
It should be a list of (LANGUAGE . EXCEPTION-LIST).
|
||||||
|
|
||||||
LANGUAGE is nil, which means the exceptions apply regardless of
|
LANGUAGE can be nil, which means the exceptions apply regardless of
|
||||||
the current dictionary, or a regular expression matching the
|
the current dictionary, or a regular expression matching the
|
||||||
dictionary name (`ispell-local-dictionary' or
|
dictionary name (`ispell-local-dictionary' or
|
||||||
`ispell-dictionary') for which the exceptions should apply.
|
`ispell-dictionary') for which the exceptions should apply.
|
||||||
|
|
|
||||||
|
|
@ -42,7 +42,7 @@ INLINE_HEADER_BEGIN
|
||||||
F9..FF 11111yyy
|
F9..FF 11111yyy
|
||||||
|
|
||||||
In each bit pattern, 'x' and 'y' each represent a single bit of the
|
In each bit pattern, 'x' and 'y' each represent a single bit of the
|
||||||
character code payload, and least one 'y' must be a 1 bit.
|
character code payload, and at least one 'y' must be a 1 bit.
|
||||||
In the 5-byte sequence, the 22-bit payload cannot exceed 3FFF7F.
|
In the 5-byte sequence, the 22-bit payload cannot exceed 3FFF7F.
|
||||||
*/
|
*/
|
||||||
|
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue