]> git.eshelyaron.com Git - emacs.git/commitdiff
; Improve documentation of function-type display
authorEli Zaretskii <eliz@gnu.org>
Tue, 7 Jan 2025 15:20:22 +0000 (17:20 +0200)
committerEshel Yaron <me@eshelyaron.com>
Sun, 12 Jan 2025 10:58:56 +0000 (11:58 +0100)
* etc/NEWS: Document 'help-display-function-type'.

* doc/lispref/functions.texi (Declare Form):
* doc/lispref/objects.texi (Type Specifiers):
* doc/emacs/help.texi (Name Help): Better indexing of function
types.  (Bug#65288)

(cherry picked from commit ee1034422b0c84722a237ab6fdd410ab74674ee6)

doc/emacs/help.texi
doc/lispref/functions.texi
doc/lispref/objects.texi

index b379de5d95b4936c5f4604b5cd6bc1a85a7519d2..5c8be6a678c27ffeb35f2fafb195adaa4f13907b 100644 (file)
@@ -291,7 +291,8 @@ yet further information is often reachable by clicking or typing
 @key{RET} on emphasized parts of the text.
 
 @cindex function type specifier
-
+@cindex declared type of a function
+@cindex inferred type of a function
 The function type, if known, is expressed with a @dfn{function type
 specifier} (@pxref{Type Specifiers,,,elisp, The Emacs Lisp Reference
 Manual}), it will be specified if the type was manually declared by a
index c659ecaf3f837eadb5d48a834a78b9bbd79791eb..772ffd8a1365d5da28b5bb15d9ee42e3852ea724 100644 (file)
@@ -2726,6 +2726,7 @@ function.  This allows function-level control of the safety level used
 for the code emitted for the function (@pxref{Native-Compilation
 Variables}).
 
+@cindex function type declaration
 @item (ftype @var{type} &optional @var{function})
 Declare @var{type} to be the type of this function.  This is used for
 documentation by @code{describe-function}.  Also it can be used by the
index 3bd5a4528b0b4cc5f53949e496c3421af1ee46ac..630765213a2889f56aed64aea021763aec496320 100644 (file)
@@ -1545,6 +1545,7 @@ The @code{not} type specifier defines any type except the specified one.
 The @code{member} type specifier allows to specify a type that includes
 only the explicitly listed values.
 
+@cindex declared type of a function
 @item (function (@var{arg-1-type} @dots{} @var{arg-n-type}) @var{return-type})
 The @code{function} type specifier is used to describe the argument
 types and the return type of a function.  Argument types can be interleaved