branch: elpa/sweeprolog
commit e73520488e907435342c9f2e4f4c945850a8fdb1
Author: Eshel Yaron <m...@eshelyaron.com>
Commit: Eshel Yaron <m...@eshelyaron.com>
DOC: document new eldoc integration
---
NEWS.org | 12 ++++++++++++
README.org | 14 ++++++++++++++
sweeprolog.el | 2 +-
3 files changed, 27 insertions(+), 1 deletion(-)
diff --git a/NEWS.org b/NEWS.org
index ca378a40ce..99bb5a8bc3 100644
--- a/NEWS.org
+++ b/NEWS.org
@@ -11,6 +11,18 @@ SWI-Prolog in Emacs.
For further details, please consult the manual:
<https://eshelyaron.com/sweep.html>.
+* Version 0.4.7 on 2022-10-01
+
+** Added integration with =eldoc=
+
+=sweeprolog.el= can now leverage =eldoc= to display short documentation
+for the Prolog predicate at point in =sweeprolog-mode= buffers.
+
+** New user option =sweeprolog-enable-eldoc=
+
+Boolean flag, enabled by default. When customized to nil,
+=sweeprolog-mode= integration with =eldoc= is disabled.
+
* Version 0.4.6 on 2022-10-01
** Added integration with =auto-insert=
diff --git a/README.org b/README.org
index 554adb51e9..c998bc6818 100644
--- a/README.org
+++ b/README.org
@@ -682,6 +682,20 @@ To automatically insert the module skeleton when opening
new files in
information about =auto-insert= and its customization options, see
[[info:autotype#Autoinserting][Autoinserting in the Autotyping manual]].
+** Displaying predicate documentation
+:PROPERTIES:
+:CUSTOM_ID: eldoc-integration
+:END:
+
+=sweep= integrates with the Emacs minor mode =ElDoc=, which automatically
+displays documentation for the predicate at point. Whenever the
+cursor enters a predicate definition or invocation, the signature and
+summary of that predicate are displayed in the echo area at the bottom
+of the frame.
+
+#+VINDEX: sweeprolog-enable-eldoc
+To disable the =ElDoc= integration in =sweeprolog-mode= buffers, customize
+the user option =sweeprolog-enable-eldoc= to nil.
* The Prolog top-level
:PROPERTIES:
diff --git a/sweeprolog.el b/sweeprolog.el
index eaae52afae..36fe09aaaa 100644
--- a/sweeprolog.el
+++ b/sweeprolog.el
@@ -6,7 +6,7 @@
;; Maintainer: Eshel Yaron <~eshel/d...@lists.sr.ht>
;; Keywords: prolog languages extensions
;; URL: https://git.sr.ht/~eshel/sweep
-;; Package-Version: 0.4.6
+;; Package-Version: 0.4.7
;; Package-Requires: ((emacs "28"))
;; This file is NOT part of GNU Emacs.
