branch: externals/hyperbole
commit d2b007c1ae38d7674f9352b284adb7cdf2388615
Author: Mats Lidell <mats.lid...@lidells.se>
Commit: GitHub <nore...@github.com>
Remove docstring warnings (#297)
---
ChangeLog | 4 ++++
hbdata.el | 6 +++---
hib-kbd.el | 4 ++--
hmouse-info.el | 4 ++--
hui.el | 4 ++--
hywconfig.el | 8 ++++----
6 files changed, 17 insertions(+), 13 deletions(-)
diff --git a/ChangeLog b/ChangeLog
index a1584f9471..35113e2102 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,7 @@
+2023-01-20 Mats Lidell <ma...@gnu.org>
+
+* Remove docstring warnings.
+
2023-01-15 Mats Lidell <ma...@gnu.org>
* hsmail.el: Remove #-mark for symbol check.
diff --git a/hbdata.el b/hbdata.el
index aa750aaaae..87ed9e4344 100644
--- a/hbdata.el
+++ b/hbdata.el
@@ -3,7 +3,7 @@
;; Author: Bob Weiner
;;
;; Orig-Date: 2-Apr-91
-;; Last-Mod: 5-Nov-22 at 14:24:56 by Bob Weiner
+;; Last-Mod: 20-Jan-23 at 23:17:59 by Mats Lidell
;;
;; Copyright (C) 1991-2021 Free Software Foundation, Inc.
;; See the "HY-COPY" file for license information.
@@ -100,8 +100,8 @@
(car hbdata))
(defun hbdata:loc-p (hbdata)
- "[Hyp V1] Return 'L iff HBDATA referent is within a local file system.
-Return 'R if remote and nil if irrelevant for button action type."
+ "[Hyp V1] Return \\='L iff HBDATA referent is within a local file system.
+Return \\='R if remote and nil if irrelevant for button action type."
(nth 1 hbdata))
(defun hbdata:modifier (hbdata)
diff --git a/hib-kbd.el b/hib-kbd.el
index d11a5f1354..f622cf311c 100644
--- a/hib-kbd.el
+++ b/hib-kbd.el
@@ -3,7 +3,7 @@
;; Author: Bob Weiner
;;
;; Orig-Date: 22-Nov-91 at 01:37:57
-;; Last-Mod: 27-Oct-22 at 18:46:16 by Bob Weiner
+;; Last-Mod: 20-Jan-23 at 22:19:34 by Mats Lidell
;;
;; Copyright (C) 1991-2022 Free Software Foundation, Inc.
;; See the "HY-COPY" file for license information.
@@ -463,7 +463,7 @@ For an approximate inverse of this, see `key-description'."
(defun kbd-key:extended-command-p (key-series)
"Return non-nil if the KEY-SERIES is a normalized extended command
invocation.
-That is, 'M-x command'."
+That is, `M-x command'."
(when (stringp key-series)
(string-match kbd-key:extended-command-prefix key-series)))
diff --git a/hmouse-info.el b/hmouse-info.el
index 5e10db04ae..1253710486 100644
--- a/hmouse-info.el
+++ b/hmouse-info.el
@@ -3,7 +3,7 @@
;; Author: Bob Weiner
;;
;; Orig-Date: 04-Apr-89
-;; Last-Mod: 12-Oct-22 at 22:52:44 by Mats Lidell
+;; Last-Mod: 20-Jan-23 at 22:19:33 by Mats Lidell
;;
;; Copyright (C) 1989-2022 Free Software Foundation, Inc.
;; See the "HY-COPY" file for license information.
@@ -113,7 +113,7 @@ If assist-key is pressed within:
(3) the File entry of a Node Header (first line),
the `DIR' root-level node is found;
(4) at the end of the current node, the Previous node is found (this will
- return from subtrees if the function 'Info-global-prev is bound);
+ return from subtrees if the function `Info-global-prev' is bound);
(5) anywhere else (e.g. at the end of a line), the current node entry is
scrolled down one windowful.
diff --git a/hui.el b/hui.el
index 6419a21eaa..311902b5c9 100644
--- a/hui.el
+++ b/hui.el
@@ -3,7 +3,7 @@
;; Author: Bob Weiner
;;
;; Orig-Date: 19-Sep-91 at 21:42:03
-;; Last-Mod: 8-Jan-23 at 10:22:39 by Mats Lidell
+;; Last-Mod: 20-Jan-23 at 23:16:41 by Mats Lidell
;;
;; Copyright (C) 1991-2021 Free Software Foundation, Inc.
;; See the "HY-COPY" file for license information.
@@ -781,7 +781,7 @@ BUT defaults to the button whose label point is within."
(defun hui:hbut-label (default-label func-name &optional prompt)
"Read button label from user using DEFAULT-LABEL and caller's FUNC-NAME.
-Optional PROMPT string replaces the standard prompt of 'Button label: '."
+Optional PROMPT string replaces the standard prompt of `Button label: '."
(hargs:read (if (stringp prompt) prompt "Button label: ")
(lambda (lbl)
(and (not (string-equal lbl "")) (<= (length lbl)
(hbut:max-len))))
diff --git a/hywconfig.el b/hywconfig.el
index f7f5d7d535..cfda781e90 100644
--- a/hywconfig.el
+++ b/hywconfig.el
@@ -3,7 +3,7 @@
;; Author: Bob Weiner
;;
;; Orig-Date: 15-Mar-89
-;; Last-Mod: 6-Nov-22 at 13:04:26 by Bob Weiner
+;; Last-Mod: 20-Jan-23 at 22:20:55 by Mats Lidell
;;
;; Copyright (C) 1989-2022 Free Software Foundation, Inc.
;; See the "../HY-COPY" file for license information.
@@ -136,9 +136,9 @@ Then deletes this new configuration from the ring."
;;;###autoload
(defun hywconfig-delete-pop-continue ()
- "Replace the current frame's window configuration with the most recently
saved.
-Delete this new configuration from the ring. If the hywconfig ring is not
empty,
-then stay in the hywconfig menu."
+ "Replace current frame's window configuration with the most recently saved.
+Delete this new configuration from the ring. If the hywconfig
+ring is not empty, then stay in the hywconfig menu."
(interactive)
(hywconfig-delete-pop)
(unless (hywconfig-ring-empty-p)
