; Expand 'elisp-fontify-symbol' and 'elisp-scope-analyze-form' docs

See discussion at
https://yhetil.org/emacs/868q9wag3h.fsf@gnu.org/

* lisp/progmodes/elisp-mode.el (elisp-fontify-symbol):
* lisp/emacs-lisp/elisp-scope.el (elisp-scope-analyze-form):
Expand docstring.
This commit is contained in:
Eshel Yaron 2026-05-06 15:24:53 +02:00
parent eae96d9fcb
commit 39e1505683
No known key found for this signature in database
GPG key ID: EF3EE9CA35D78618
2 changed files with 7 additions and 1 deletions

View file

@ -2828,6 +2828,10 @@ 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.
CALLBACK should use ID by checking if it is nil or `equal' to other ID
values produced in the same call to this function. The specific value
of a given ID is otherwise meaningless.
As an example, when this function analyzes the following form
(lambda (mode) (let ((mode (or mode major-mode))) (symbol-name mode)))

View file

@ -618,7 +618,9 @@ semantic highlighting takes precedence."
If `elisp-add-help-echo' is non-nil, also annotate the symbol with the
`help-echo' text property. If `cursor-sensor-mode' is enabled and ID is
non-nil, also annotate the symbol with `cursor-sensor-functions'.
non-nil (i.e. SYM is local variable), also annotate the symbol with
`cursor-sensor-functions' that highlight all occurrences of SYM with the
same ID whenever point is on this SYM.
For the precise meaning of the arguments of this function, see the
docstring of `elisp-scope-analyze-form'. This function is intended for