Mercurial > emacs
changeset 102198:c0840f340e81
(Property Lists): Emphasize that property lists are not restricted to symbol cells.
(Other Plists): Copyedit.
author | Chong Yidong <cyd@stupidchicken.com> |
---|---|
date | Sun, 22 Feb 2009 21:56:05 +0000 |
parents | 87b67241e0a8 |
children | 6f66db4c1c98 |
files | doc/lispref/symbols.texi |
diffstat | 1 files changed, 14 insertions(+), 16 deletions(-) [+] |
line wrap: on
line diff
--- a/doc/lispref/symbols.texi Sun Feb 22 21:55:55 2009 +0000 +++ b/doc/lispref/symbols.texi Sun Feb 22 21:56:05 2009 +0000 @@ -403,15 +403,17 @@ @cindex plist A @dfn{property list} (@dfn{plist} for short) is a list of paired -elements stored in the property list cell of a symbol. Each of the -pairs associates a property name (usually a symbol) with a property or -value. Property lists are generally used to record information about a -symbol, such as its documentation as a variable, the name of the file -where it was defined, or perhaps even the grammatical class of the -symbol (representing a word) in a language-understanding system. +elements. Each of the pairs associates a property name (usually a +symbol) with a property or value. - Character positions in a string or buffer can also have property lists. -@xref{Text Properties}. + Every symbol has a cell that stores a property list (@pxref{Symbol +Components}). This property list is used to record information about +the symbol, such as its variable documentation and the name of the +file where it was defined. + + Property lists can also be used in other contexts. For instance, +you can assign property lists to character positions in a string or +buffer. @xref{Text Properties}. The property names and values in a property list can be any Lisp objects, but the names are usually symbols. Property list functions @@ -529,8 +531,10 @@ that are stored in places other than symbols: @defun plist-get plist property -This returns the value of the @var{property} property -stored in the property list @var{plist}. For example, +This returns the value of the @var{property} property stored in the +property list @var{plist}. It accepts a malformed @var{plist} +argument. If @var{property} is not found in the @var{plist}, it +returns @code{nil}. For example, @example (plist-get '(foo 4) 'foo) @@ -539,12 +543,6 @@ @result{} 4 (plist-get '(foo 4 bad) 'bad) @result{} @code{nil} -@end example - -It accepts a malformed @var{plist} argument and always returns @code{nil} -if @var{property} is not found in the @var{plist}. For example, - -@example (plist-get '(foo 4 bad) 'bar) @result{} nil @end example