Document, in the Elisp manual, how to get a character's raw syntax descriptor

* doc/lispref/syntax.texi (Syntax Table internals): mention the use of `aref'
to get a character's raw syntax descriptor.
This commit is contained in:
Alan Mackenzie 2018-02-22 18:21:47 +00:00
parent 5fb29578de
commit 76f5242838

View file

@ -972,6 +972,10 @@ encodes the syntax class and syntax flags, according to the table
below. @var{matching-char}, if non-@code{nil}, specifies a matching
character (similar to the second character in a syntax descriptor).
@cindex syntax tables (accessing elements of)
Use @code{aref} (@pxref{Array Functions}) to get the raw syntax
descriptor of a character, e.g. @w{@code{(aref (syntax-table) ch)}}.
Here are the syntax codes corresponding to the various syntax
classes: