emacs-elpa-diffs
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

[nongnu] elpa/gnuplot d70c94a 065/184: Better docstrings for context-sen


From: ELPA Syncer
Subject: [nongnu] elpa/gnuplot d70c94a 065/184: Better docstrings for context-sensitive and inline-image modes
Date: Sun, 29 Aug 2021 11:03:16 -0400 (EDT)

branch: elpa/gnuplot
commit d70c94a1b34da34b56abc8845c5702e653c7c31e
Author: joddie <jonxfield@gmail.com>
Commit: joddie <jonxfield@gmail.com>

    Better docstrings for context-sensitive and inline-image modes
---
 gnuplot-context.el | 35 ++++++++++++++++++++++++++++++++---
 gnuplot.el         |  6 ++++++
 2 files changed, 38 insertions(+), 3 deletions(-)

diff --git a/gnuplot-context.el b/gnuplot-context.el
index 1954b28..b4de23b 100644
--- a/gnuplot-context.el
+++ b/gnuplot-context.el
@@ -275,15 +275,44 @@ These have to be compiled from the Gnuplot source tree 
using
 ;;;; Customization interface, etc.
 (defun gnuplot-context-sensitive-mode (&optional enable)
   "Turn gnuplot-mode context-sensitive completion and help on and off.
-Works like a minor mode: with argument, turn context-sensitive
-mode on if ENABLE is positive, otherwise turn it off. With no
-argument, toggle context-sensitive mode."
+
+When context-sensitive mode is enabled, gnuplot-mode tries to
+provide more useful completions and help suggestions for built-in
+keywords and functions by parsing each command as you type.  It
+attempts to take into account Gnuplot's many abbreviated
+keywords.  For example, with point at the end of a line reading
+\"plot 'datafile' w \", typing \\[completion-at-point] will pop
+up a list of plotting styles.
+
+\\[completion-at-point] will complete the keyword at point based
+on its context in the command. To make keyword completion work on
+pressing TAB, set `tab-always-indent' to `complete', or customize
+`gnuplot-tab-completion' to make this automatic in gnuplot-mode
+buffers.
+
+\\[gnuplot-info-at-point] will try to find the most relevant
+Gnuplot info node for the construction at point, prompting for a
+node name if nothing is found.
+
+In addition, \\[gnuplot-help-function] will pop up a brief
+summary of the syntax at point in the minibuffer. To have one-line
+syntax summaries appear in the echo area as you type, toggle
+`eldoc-mode' or customize `gnuplot-eldoc-mode'.
+
+Note: help strings for eldoc-mode and \\[gnuplot-help-function]
+need to be provided in an Emacs-readable form by the Gnuplot
+distribution. See gnuplot-context.el for details.
+
+Works like a minor mode: with a prefix argument, turn
+context-sensitive mode on if positive, otherwise turn it
+off. With no argument, toggle context-sensitive mode."
   (interactive "P")
   (setq gnuplot-context-sensitive-mode
         (if (null enable) (not gnuplot-context-sensitive-mode)
             (> (prefix-numeric-value enable) 0)))
   
   (if gnuplot-context-sensitive-mode
+      ;; Turn on
       (progn
         (when (called-interactively-p 'any)
           (message "Gnuplot context-sensitive help & completion enabled."))
diff --git a/gnuplot.el b/gnuplot.el
index 1cdeea5..dad7adb 100644
--- a/gnuplot.el
+++ b/gnuplot.el
@@ -2238,6 +2238,12 @@ gnuplot process buffer will be displayed in a window."
 
 (defun gnuplot-inline-image-mode (&optional enable)
   "Turn inline display of Gnuplot output in the comint buffer on or off.
+
+This works by having Gnuplot save its output to temporary .png
+files using \"set terminal png\" and \"set output\" commands,
+which are sent invisibly to the running Gnuplot process between
+user commands.
+
 Works like a minor mode: with argument, turn inline image display
 on if ENABLE is positive, otherwise turn it off and restores the
 previous Gnuplot terminal setting. With no argument, toggle



reply via email to

[Prev in Thread] Current Thread [Next in Thread]