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

Document 'function-put'

Browse source 
* doc/lispref/symbols.texi (Symbol Plists): Document
'function-put'.  Update documentation of 'function-get'.
This commit is contained in:
Eli Zaretskii 2016-01-16 17:13:16 +02:00
parent 964ba0f526
commit 9f493814bb
2 changed files with 16 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

17
doc/lispref/symbols.texi
View file

@ -461,10 +461,23 @@ You could define @code{put} in terms of @code{setplist} and
@end example
@end defun
@defun function-get symbol property
@defun function-get symbol property &optional autoload
This function is identical to @code{get}, except that if @var{symbol}
is the name of a function alias, it looks in the property list of the
symbol naming the actual function. @xref{Defining Functions}.
symbol naming the actual function. @xref{Defining Functions}. If the
optional argument @var{autoload} is non-@code{nil}, and @var{symbol}
is auto-loaded, this function will try to autoload it, since
autoloading might set @var{property} of @var{symbol}. If
@var{autoload} is the symbol @code{macro}, only try autoloading if
@var{symbol} is an auto-loaded macro.
@end defun
@defun function-put function property value
This function sets @var{property} of @var{function} to @var{value}.
@var{function} should be a symbol. This function is preferred to
calling @code{put} for setting properties of a function, because it
will allow us some day to implement remapping of old properties to new
ones.
@end defun
@node Standard Properties

1
etc/NEWS
View file

@ -1472,6 +1472,7 @@ MS-Windows doesn't support UTF-8 as codeset in its locales.
but makes `called-interactively-p' treat the function as (you guessed it)
called interactively.
+++
** New function `function-put' to use instead of `put' for function properties.
+++