; (elisp-scope-analyze-form): Improve docstring.

This commit is contained in:
Eshel Yaron 2026-05-05 14:30:59 +02:00
parent 283b47ab2e
commit 0649c501ad
No known key found for this signature in database
GPG key ID: EF3EE9CA35D78618

View file

@ -2821,10 +2821,12 @@ It is passed to `elisp-scope-1', which see."
Call CALLBACK for each analyzed symbol SYM with arguments ROLE, POS,
SYM, ID and DEF, where ROLE is a symbol that specifies the semantics of
SYM; POS is the position of SYM in STREAM; ID is an object that uniquely
identifies (co-)occurrences of SYM in the current defun; and DEF is the
position in which SYM is locally defined, or nil. If SYM is itself a
binding occurrence, then POS and DEF are equal. If SYM is not lexically
bound, then DEF is nil.
identifies the local reference of SYM in the current defun, so different
occurrences of SYM get the same ID (up to `equal') if and only if they
refer to the same object; and lastly, DEF is the position in which SYM
is locally defined, or nil. If SYM is itself a binding occurrence, then
POS and DEF are equal. If SYM is not lexically bound, then DEF is nil
and so is ID.
If STREAM is nil, it defaults to the current buffer. When reading from
the current buffer, this function leaves point at the end of the form.