Improve function-alias-p documentation

* doc/lispref/functions.texi (Defining Functions): Improve the text.
This commit is contained in:
Robert Pluim 2022-01-14 08:25:07 +01:00 committed by Lars Ingebrigtsen
parent 1158c880e2
commit 9cc1344c9f

View file

@ -670,11 +670,10 @@ records. @xref{Function Cells}.
@end defun
@defun function-alias-p object &optional noerror
Use the @code{function-alias-p} function to check whether an object is
a function alias. If it isn't, this predicate will return
@code{nil}. If it is, the value returned will be a list of symbol
representing the function alias chain. For instance, if @code{a} is
an alias for @code{b}, and @code{b} is an alias for @code{c}:
Checks whether @var{object} is a function alias. If it is, it returns
a list of symbols representing the function alias chain, else
@code{nil}. For instance, if @code{a} is an alias for @code{b}, and
@code{b} is an alias for @code{c}:
@example
(function-alias-p 'a)