[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[nongnu] elpa/sly eb67be9: Close #371: fix and detail documentation of s
From: |
ELPA Syncer |
Subject: |
[nongnu] elpa/sly eb67be9: Close #371: fix and detail documentation of sly-who-calls, etc |
Date: |
Thu, 14 Jan 2021 04:57:09 -0500 (EST) |
branch: elpa/sly
commit eb67be9698794ba66a09f46b7cfffab742863a91
Author: Pierre Neidhardt <mail@ambrevar.xyz>
Commit: GitHub <noreply@github.com>
Close #371: fix and detail documentation of sly-who-calls, etc
* sly.el (sly-who-calls): Mention `sly-list-callers' in the docstring.
(sly-calls-who): Mention `sly-list-callees' in the docstring.
(sly-list-callers): Mention `sly-who-calls' in the docstring.
(sly-list-callees): Mention `sly-calls-who' in the docstring.
* slynk/slynk-backend.lisp (calls-who): Fix docstring.
---
sly.el | 15 +++++++++++----
slynk/slynk-backend.lisp | 2 +-
2 files changed, 12 insertions(+), 5 deletions(-)
diff --git a/sly.el b/sly.el
index aa32a75..35ea024 100644
--- a/sly.el
+++ b/sly.el
@@ -4799,12 +4799,17 @@ METHOD is used to set `sly-xref--popup-method', which
see."
;;;;; XREF commands
(defun sly-who-calls (symbol)
- "Show all known callers of the function SYMBOL."
+ "Show all known callers of the function SYMBOL.
+This is implemented with special compiler support, see `sly-list-callers' for a
+portable alternative."
(interactive (list (sly-read-symbol-name "Who calls: " t)))
(sly-xref :calls symbol))
(defun sly-calls-who (symbol)
- "Show all known functions called by the function SYMBOL."
+ "Show all known functions called by the function SYMBOL.
+This is implemented with special compiler support and may not be supported by
+all implementations.
+See `sly-list-callees' for a portable alternative."
(interactive (list (sly-read-symbol-name "Who calls: " t)))
(sly-xref :calls-who symbol))
@@ -4834,12 +4839,14 @@ METHOD is used to set `sly-xref--popup-method', which
see."
(sly-xref :specializes symbol))
(defun sly-list-callers (symbol-name)
- "List the callers of SYMBOL-NAME in a xref window."
+ "List the callers of SYMBOL-NAME in a xref window.
+See `sly-who-calls' for an implementation-specific alternative."
(interactive (list (sly-read-symbol-name "List callers: ")))
(sly-xref :callers symbol-name))
(defun sly-list-callees (symbol-name)
- "List the callees of SYMBOL-NAME in a xref window."
+ "List the callees of SYMBOL-NAME in a xref window.
+See `sly-calls-who' for an implementation-specific alternative."
(interactive (list (sly-read-symbol-name "List callees: ")))
(sly-xref :callees symbol-name))
diff --git a/slynk/slynk-backend.lisp b/slynk/slynk-backend.lisp
index 0bb27e1..0d10577 100644
--- a/slynk/slynk-backend.lisp
+++ b/slynk/slynk-backend.lisp
@@ -1175,7 +1175,7 @@ The results is a list ((DSPEC LOCATION) ...)."
:not-implemented)
(definterface calls-who (function-name)
- "Return the call sites of FUNCTION-NAME (a symbol).
+ "Return the list of functions called by FUNCTION-NAME (a symbol).
The results is a list ((DSPEC LOCATION) ...)."
(declare (ignore function-name))
:not-implemented)
[Prev in Thread] |
Current Thread |
[Next in Thread] |
- [nongnu] elpa/sly eb67be9: Close #371: fix and detail documentation of sly-who-calls, etc,
ELPA Syncer <=