diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/emacs/anti.texi | 6 | ||||
| -rw-r--r-- | doc/emacs/display.texi | 9 | ||||
| -rw-r--r-- | doc/emacs/maintaining.texi | 18 | ||||
| -rw-r--r-- | doc/lispref/sequences.texi | 60 |
4 files changed, 50 insertions, 43 deletions
diff --git a/doc/emacs/anti.texi b/doc/emacs/anti.texi index aadc85a293f..68a65a7c0c1 100644 --- a/doc/emacs/anti.texi +++ b/doc/emacs/anti.texi @@ -75,9 +75,9 @@ benefit, this removes many useless entries at the beginning of the @kbd{C-h b} output. The @code{electric-quote-mode} has been deleted, so there's only the one true quoting method now---using the plain-@acronym{ASCII} quote characters. And if that's not enough, the -doc strings and other messages show text quoted `like this' and "like -this" as they were written, instead of arbitrarily replacing them -with Unicode ``curved quote'' characters. The +doc strings and other messages show text quoted @t{`like this'} +as they were written, instead of arbitrarily replacing them +with Unicode ``curved quote'' characters @t{‘like this’}. The @code{text-quoting-style} variable becomes therefore unneeded and was removed. As result, text produced by Emacs can be sent to those venerable teletypes again, yeah! diff --git a/doc/emacs/display.texi b/doc/emacs/display.texi index e3b24033a1a..c8987c279c5 100644 --- a/doc/emacs/display.texi +++ b/doc/emacs/display.texi @@ -1476,15 +1476,18 @@ elisp, The Emacs Lisp Reference Manual}. @cindex glyphless characters @cindex characters with no font glyphs +@cindex glyphless-char face On graphical displays, some characters may have no glyphs in any of the fonts available to Emacs. These @dfn{glyphless characters} are normally displayed as boxes containing the hexadecimal character code. Similarly, on text terminals, characters that cannot be displayed using the terminal encoding (@pxref{Terminal Coding}) are normally displayed as question signs. You can control the display method by -customizing the variable @code{glyphless-char-display-control}. -@xref{Glyphless Chars,, Glyphless Character Display, elisp, The Emacs -Lisp Reference Manual}, for details. +customizing the variable @code{glyphless-char-display-control}. You +can also customize the @code{glyphless-char} face to make these +characters more prominent on display. @xref{Glyphless Chars,, +Glyphless Character Display, elisp, The Emacs Lisp Reference Manual}, +for details. @cindex curly quotes @cindex curved quotes diff --git a/doc/emacs/maintaining.texi b/doc/emacs/maintaining.texi index e81a190170c..168f26dee76 100644 --- a/doc/emacs/maintaining.texi +++ b/doc/emacs/maintaining.texi @@ -1289,15 +1289,15 @@ whose state is that of the item at point. @findex vc-dir-mark @findex vc-dir-mark-all-files While in the VC Directory buffer, all the files that you mark with -@kbd{m} (@code{vc-dir-mark}) or @kbd{M} (@code{vc-dir-mark}) are in -the current VC fileset. If you mark a directory entry with @kbd{m}, -all the listed files in that directory tree are in the current VC -fileset. The files and directories that belong to the current VC -fileset are indicated with a @samp{*} character in the VC Directory -buffer, next to their VC status. In this way, you can set up a -multi-file VC fileset to be acted on by VC commands like @w{@kbd{C-x v -v}} (@pxref{Basic VC Editing}), @w{@kbd{C-x v =}} (@pxref{Old -Revisions}), and @w{@kbd{C-x v u}} (@pxref{VC Undo}). +@kbd{m} (@code{vc-dir-mark}) or @kbd{M} (@code{vc-dir-mark-all-files}) +are in the current VC fileset. If you mark a directory entry with +@kbd{m}, all the listed files in that directory tree are in the +current VC fileset. The files and directories that belong to the +current VC fileset are indicated with a @samp{*} character in the VC +Directory buffer, next to their VC status. In this way, you can set +up a multi-file VC fileset to be acted on by VC commands like +@w{@kbd{C-x v v}} (@pxref{Basic VC Editing}), @w{@kbd{C-x v =}} +(@pxref{Old Revisions}), and @w{@kbd{C-x v u}} (@pxref{VC Undo}). The VC Directory buffer also defines some single-key shortcuts for VC commands with the @kbd{C-x v} prefix: @kbd{=}, @kbd{+}, @kbd{l}, diff --git a/doc/lispref/sequences.texi b/doc/lispref/sequences.texi index 002a9ceceec..f7d26e54d0b 100644 --- a/doc/lispref/sequences.texi +++ b/doc/lispref/sequences.texi @@ -435,23 +435,27 @@ a predicate, this should be a function of one argument. The @file{seq.el} library can be extended to work with additional types of sequential data-structures. For that purpose, all functions -are defined using @code{cl-defgeneric}. +are defined using @code{cl-defgeneric}. @xref{Generic Functions}, for +more details about using @code{cl-defgeneric} for adding extensions. @defun seq-elt sequence index - This function the element at the index @var{index} in -@var{sequence}. @var{index} can be an integer from zero up to the -length of @var{sequence} minus one. For out-of-range values on -built-in sequence types, @code{seq-elt} behaves like @code{elt}. -@xref{Definition of elt}. + This function returns the element of @var{sequence} at the specified +@var{index}, which is an integer whose valid value range is zero to +one less than the length of @var{sequence}. For out-of-range values +on built-in sequence types, @code{seq-elt} behaves like @code{elt}. +For the details, see @ref{Definition of elt}. @example @group (seq-elt [1 2 3 4] 2) @result{} 3 @end group +@end example - @code{seq-elt} returns settable places using @code{setf}. + @code{seq-elt} returns places settable using @code{setf} +(@pxref{Setting Generalized Variables}). +@example @group (setq vec [1 2 3 4]) (setf (seq-elt vec 2) 5) @@ -552,7 +556,7 @@ starting from the first one for which @var{predicate} returns @code{nil}. @defun seq-do function sequence This function applies @var{function} to each element of -@var{sequence} in turn (presumably for side effects) and returns +@var{sequence} in turn (presumably for side effects), and returns @var{sequence}. @end defun @@ -589,9 +593,10 @@ returned value is a list. @defun seq-mapn function &rest sequences This function returns the result of applying @var{function} to each -element of @var{sequences}. The arity of @var{function} must match -the number of sequences. Mapping stops at the shortest sequence, and -the returned value is a list. +element of @var{sequences}. The arity (@pxref{What Is a Function, +sub-arity}) of @var{function} must match the number of sequences. +Mapping stops at the end of the shortest sequence, and the returned +value is a list. @example @group @@ -690,13 +695,13 @@ applying @var{predicate} to each element of @var{sequence} in turn. @end defun @defun seq-find predicate sequence &optional default - This function returns the first element for which @var{predicate} -returns non-@code{nil} in @var{sequence}. If no element matches -@var{predicate}, @var{default} is returned. + This function returns the first element in @var{sequence} for which +@var{predicate} returns non-@code{nil}. If no element matches +@var{predicate}, the function returns @var{default}. Note that this function has an ambiguity if the found element is -identical to @var{default}, as it cannot be known if an element was -found or not. +identical to @var{default}, as in that case it cannot be known whether +an element was found or not. @example @group @@ -869,7 +874,7 @@ list if @var{type} is @code{nil}. This function returns a list of the elements of @var{sequence} grouped into sub-sequences of length @var{n}. The last sequence may contain less elements than @var{n}. @var{n} must be an integer. If -@var{n} is a negative integer or 0, nil is returned. +@var{n} is a negative integer or 0, the return value is @code{nil}. @example @group @@ -947,9 +952,9 @@ of type @var{type}. @var{type} can be one of the following symbols: @end defun @defun seq-min sequence - This function returns the smallest element of -@var{sequence}. @var{sequence} must be a sequence of numbers or -markers. + This function returns the smallest element of @var{sequence}. The +elements of @var{sequence} must be numbers or markers +(@pxref{Markers}). @example @group @@ -964,9 +969,8 @@ markers. @end defun @defun seq-max sequence - This function returns the largest element of -@var{sequence}. @var{sequence} must be a sequence of numbers or -markers. + This function returns the largest element of @var{sequence}. The +elements of @var{sequence} must be numbers or markers. @example @group @@ -982,16 +986,16 @@ markers. @defmac seq-doseq (var sequence) body@dots{} @cindex sequence iteration - This macro is like @code{dolist}, except that @var{sequence} can be a list, -vector or string (@pxref{Iteration} for more information about the -@code{dolist} macro). This is primarily useful for side-effects. + This macro is like @code{dolist} (@pxref{Iteration, dolist}), except +that @var{sequence} can be a list, vector or string. This is +primarily useful for side-effects. @end defmac @defmac seq-let arguments sequence body@dots{} @cindex sequence destructuring This macro binds the variables defined in @var{arguments} to the -elements of the sequence @var{sequence}. @var{arguments} can itself -include sequences allowing for nested destructuring. +elements of @var{sequence}. @var{arguments} can themselves include +sequences, allowing for nested destructuring. The @var{arguments} sequence can also include the @code{&rest} marker followed by a variable name to be bound to the rest of |