procyberian/emacs
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Improve documentation of records

Browse source 
* doc/lispref/Makefile.in (srcs): Add the forgotten records.texi.
* doc/lispref/records.texi (Records): Recommend that record type
names use package-naming conventions.

* etc/NEWS: Add the naming convention recommendation for record
types.
This commit is contained in:
Eli Zaretskii 2017-12-22 12:04:23 +02:00
parent 22b3075bb2
commit 861d110078
3 changed files with 13 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

1
doc/lispref/Makefile.in
View file

@ -118,6 +118,7 @@ srcs = \
$(srcdir)/package.texi \
$(srcdir)/positions.texi \
$(srcdir)/processes.texi \
$(srcdir)/records.texi \
$(srcdir)/searching.texi \
$(srcdir)/sequences.texi \
$(srcdir)/streams.texi \

9
doc/lispref/records.texi
View file

@ -5,7 +5,7 @@
@c See the file elisp.texi for copying conditions.
@node Records
@chapter Records
@cindex record
@cindex records
The purpose of records is to allow programmers to create objects
with new types that are not built into Emacs. They are used as the
@ -28,6 +28,13 @@ type descriptor, the symbol naming its type will be returned;
list specifying the contents. The first list element must be the
record type. The following elements are the record slots.
To avoid conflicts with other type names, Lisp programs that define
new types of records should normally use the naming conventions of the
package where these record types are introduced for the names of the
types. Note that the names of the types which could possibly conflict
might not be known at the time the package defining a record type is
loaded; they could be loaded at some future point in time.
A record is considered a constant for evaluation: the result of
evaluating it is the same record. This does not evaluate or even
examine the slots. @xref{Self-Evaluating Forms}.

4
etc/NEWS
View file

@ -1584,6 +1584,10 @@ functions 'make-record', 'record', and 'recordp'. Records are now
used internally to represent cl-defstruct and defclass instances, for
example.
If your program defines new record types, you should use
package-naming conventions for naming those types. This is so any
potential conflicts with other types are avoided.
+++
** 'save-some-buffers' now uses 'save-some-buffers-default-predicate'
to decide which buffers to ask about, if the PRED argument is nil.