Skip to content

Commit 235ba76

Browse files
committed
Fix docstring compilation warnings
1 parent 4c6b18f commit 235ba76

File tree

3 files changed

+36
-36
lines changed

3 files changed

+36
-36
lines changed

gnuplot-context.el

+1-1
Original file line numberDiff line numberDiff line change
@@ -2191,7 +2191,7 @@ provide more useful completions and help suggestions for built-in
21912191
keywords and functions by parsing each command as you type. It
21922192
attempts to take into account Gnuplot's many abbreviated
21932193
keywords. For example, with point at the end of a line reading
2194-
\"plot 'datafile' w \", typing \\[completion-at-point] will pop
2194+
\"plot \\='datafile\\=' w \", typing \\[completion-at-point] will pop
21952195
up a list of plotting styles.
21962196
21972197
Key bindings:

gnuplot-gui.el

+31-31
Original file line numberDiff line numberDiff line change
@@ -597,9 +597,9 @@ See the doc-string for `gnuplot-gui-all-types'.")
597597

598598
(defcustom gnuplot-gui-plot-splot-fit-style 'simple
599599
"Control the complexity of the GUI display for plot, splot, and fit.
600-
The values are 'simple, which causes a limited set of plot, splot, or
601-
fit options to be displayed, and 'complete, which attempts to display
602-
all options. The 'complete setting is prone to making errors when
600+
The values are \\='simple, which causes a limited set of plot, splot, or
601+
fit options to be displayed, and \\='complete, which attempts to display
602+
all options. The \\='complete setting is prone to making errors when
603603
parsing values already in the script buffer."
604604
:group 'gnuplot-gui
605605
:type '(radio (const :tag "Simple listing" simple)
@@ -745,54 +745,54 @@ TAG is the name used on the widget and indicates one of the options
745745
for this command, set option, or terminal type.
746746
747747
TYPE is one of
748-
'list a menu-list of strings
749-
'list* a menu-list of strings with a prefix
750-
'number a number with an optional prefix
751-
'tag like number but must be the first argument
752-
'fontsize like number but must be the last argument
753-
'range a pair of numbers like [#,#] or [#:#]
754-
'pair a pair of numbers with no punctuation and a prefix
755-
'file a quoted string and a file browser
756-
'string a quoted string with an optional prefix
757-
'string* an unquoted string with a prefix
758-
'format a quoted string and an info-link to (gnuplot)format
759-
'labels an array as needed for xtics, ytics, etc
760-
'position 2 or 3 comma separated numbers with an optional prefix
748+
\\='list a menu-list of strings
749+
\\='list* a menu-list of strings with a prefix
750+
\\='number a number with an optional prefix
751+
\\='tag like number but must be the first argument
752+
\\='fontsize like number but must be the last argument
753+
\\='range a pair of numbers like [#,#] or [#:#]
754+
\\='pair a pair of numbers with no punctuation and a prefix
755+
\\='file a quoted string and a file browser
756+
\\='string a quoted string with an optional prefix
757+
\\='string* an unquoted string with a prefix
758+
\\='format a quoted string and an info-link to (gnuplot)format
759+
\\='labels an array as needed for xtics, ytics, etc
760+
\\='position 2 or 3 comma separated numbers with an optional prefix
761761
762762
DEFAULT is the default value for this option. Note that the default
763-
for 'range and 'pair is a cons cell and the default for 'labels is a
763+
for \\='range and \\='pair is a cons cell and the default for \\='labels is a
764764
list. For most things, the best choice of DEFAULT is a string of
765765
white space or a cons cell of two strings of white space. Strings of
766766
white space are better defaults than empty strings or nil.
767767
768768
The value of REST depends upon TYPE:
769769
770-
For 'list & REST is the list of options that will go into the
771-
'list* menu-button. This can also be a symbol which
770+
For \\='list & REST is the list of options that will go into the
771+
\\='list* menu-button. This can also be a symbol which
772772
evaluates to a list containing the options to go into
773773
the menu-button. This list variable must contain the
774774
DEFAULT.
775-
For 'number REST is the prefix string (if it exists) for that number.
776-
For 'range REST is the separator, \":\" for plot ranges and
775+
For \\='number REST is the prefix string (if it exists) for that number.
776+
For \\='range REST is the separator, \":\" for plot ranges and
777777
\",\" for plot dimensions (see for example the tgif
778778
terminal type)
779-
For 'string & REST may a number denoting the width of the editable-text
780-
'string* field or it may be a string denoting a prefix. By
779+
For \\='string & REST may a number denoting the width of the editable-text
780+
\\='string* field or it may be a string denoting a prefix. By
781781
default, the width is half the width of the frame
782782
and there is no prefix. It may be useful to
783783
specify \"1\" when the input is a single character
784-
as in 'set missing'.
785-
For 'file REST determines the label placed before the file insertion
784+
as in \"set missing\".
785+
For \\='file REST determines the label placed before the file insertion
786786
field. If non-nil, then TAG is used. If nil, then
787787
the default \"File\" is used.
788-
For 'position REST is the prefix and the number of comma separated numbers
788+
For \\='position REST is the prefix and the number of comma separated numbers
789789
For others REST is not used.
790790
791791
Here is an example entry for the png terminal type:
792792
793793
(cons \"png\"
794-
'((\"SIZE\" 'list \" \" \"small\" \"medium\" \"large\")
795-
(\"COLOR\" 'list \" \" \"monochrome\" \"gray\" \"color\")))
794+
\\='((\"SIZE\" \\='list \" \" \"small\" \"medium\" \"large\")
795+
(\"COLOR\" \\='list \" \" \"monochrome\" \"gray\" \"color\")))
796796
797797
This alist is formed at load time by appending together
798798
`gnuplot-gui-terminal-types', `gnuplot-gui-set-types' and
@@ -1152,7 +1152,7 @@ arguments."
11521152

11531153
(defun gnuplot-gui-post-process-alist (type)
11541154
"A few types need some additional processing.
1155-
'range, 'pair, and 'labels are cons or list valued and need to b made
1155+
\\='range, \\='pair, and \\='labels are cons or list valued and need to b made
11561156
into strings. This is called right before inserting the arguments
11571157
into the buffer. TYPE is the object whose arguments are being set."
11581158
(let ((alist gnuplot-gui-alist)
@@ -1420,7 +1420,7 @@ SAVE-FRAME is non-nil when the widgets are being reset."
14201420
"Create a menu widget for the Gnuplot GUI.
14211421
ITEM is the object whose arguments are set by this widget, DEFAULT
14221422
is the default argument value, LIST contains the items for the pop-up
1423-
menu. STARRED is true if this a 'list* widget."
1423+
menu. STARRED is true if this a \\='list* widget."
14241424
(let ((widget
14251425
(apply 'widget-create
14261426
'menu-choice :value default :tag item :doc starred
@@ -1623,7 +1623,7 @@ the default value for the argument."
16231623
ITEM is the object whose arguments are set by this widget, DEFAULT is
16241624
the default value for the widget, SEPARATOR is a text string preceding
16251625
the numerical argument, or the prefix for a pair operator. IS-RANGE
1626-
is non-nil if this is a 'range widget."
1626+
is non-nil if this is a \\='range widget."
16271627
(widget-insert (capitalize item) ": ")
16281628
(if is-range (widget-insert "["))
16291629
(widget-create 'editable-field

gnuplot.el

+4-4
Original file line numberDiff line numberDiff line change
@@ -495,7 +495,7 @@ You can also add new items to any of these sub-menus by adding to the
495495
`with-eval-after-load' blocks in your .emacs file. Here is an example of
496496
adding the \"regis\" terminal type to the terminal sub-menu:
497497
498-
(with-eval-after-load 'gnuplot
498+
(with-eval-after-load \\='gnuplot
499499
(setq gnuplot-insertions-terminal
500500
(append gnuplot-insertions-terminal
501501
(list
@@ -1542,7 +1542,7 @@ updates Gnuplot with the appropriate \"set output\" command."
15421542
(gnuplot-send-hiding-output "set output\n") ; Flush output file
15431543
(sit-for 0.1) ; Hack: wait for Gnuplot IO to finish
15441544
(cl-ecase gnuplot-inline-image-mode
1545-
(nil nil)
1545+
((nil) nil)
15461546
(inline
15471547
(ignore-errors
15481548
(let ((image (create-image filename)))
@@ -2071,9 +2071,9 @@ and then starts `gnuplot-mode'.
20712071
It is convenient to bind this function to a global key sequence. For
20722072
example, to make the F10 key open a gnuplot script buffer, put the
20732073
following in your .emacs file:
2074-
(autoload 'gnuplot-make-buffer \"gnuplot\"
2074+
(autoload \\='gnuplot-make-buffer \"gnuplot\"
20752075
\"open a buffer in gnuplot mode\" t)
2076-
(global-set-key [(f10)] 'gnuplot-make-buffer)"
2076+
(global-set-key [(f10)] \\='gnuplot-make-buffer)"
20772077
(interactive)
20782078
(switch-to-buffer gnuplot-gnuplot-buffer)
20792079
(gnuplot-mode))

0 commit comments

Comments
 (0)