From: Eshel Yaron <me@eshelyaron.com>
Date: Sat, 1 Oct 2022 15:55:32 +0000 (+0300)
Subject: DOC: document new eldoc integration
X-Git-Tag: v0.4.7
X-Git-Url: http://git.eshelyaron.com/gitweb/?a=commitdiff_plain;h=e73520488e907435342c9f2e4f4c945850a8fdb1;p=sweep.git

DOC: document new eldoc integration
---

diff --git a/NEWS.org b/NEWS.org
index ca378a4..99bb5a8 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 554adb5..c998bc6 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 eaae52a..36fe09a 100644
--- a/sweeprolog.el
+++ b/sweeprolog.el
@@ -6,7 +6,7 @@
 ;; Maintainer: Eshel Yaron <~eshel/dev@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.