[elpa] externals/hyperbole 977ad593df: Fix most remaining docstring lengths (#278)

[ELPA Syncer]

branch: externals/hyperbole
commit 977ad593df7f08235f06eb26441e53527d9bb205
Author: Mats Lidell <mats.lidell@lidells.se>
Commit: GitHub <noreply@github.com>

    Fix most remaining docstring lengths (#278)
---
 ChangeLog      |  7 +++++++
 hib-kbd.el     | 20 ++++++++++++--------
 hpath.el       |  5 +++--
 hsys-org.el    | 22 +++++++++++-----------
 hui-em-but.el  |  4 ++--
 hui-mini.el    |  6 +++---
 hyrolo-demo.el |  4 ++--
 hyrolo.el      |  4 ++--
 8 files changed, 42 insertions(+), 30 deletions(-)

diff --git a/ChangeLog b/ChangeLog
index 866aca705f..8f25970db6 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,5 +1,12 @@
 2022-10-09  Mats Lidell  <matsl@gnu.org>
 
+* hyrolo.el:
+* hyrolo-demo.el:
+* hui-mini.el:
+* hui-em-but.el:
+* hsys-org.el:
+* hpath.el:
+* hib-kbd.el:
 * kotl/kview.el: Shorten docs strings to be within 80 char limit.
 
 2022-10-08  Mats Lidell  <matsl@gnu.org>
diff --git a/hib-kbd.el b/hib-kbd.el
index 56c6a3789f..b62226be0a 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:     21-Jul-22 at 11:40:53 by Mats Lidell
+;; Last-Mod:      7-Oct-22 at 00:06:09 by Mats Lidell
 ;;
 ;; Copyright (C) 1991-2022  Free Software Foundation, Inc.
 ;; See the "HY-COPY" file for license information.
@@ -58,7 +58,8 @@ Function keys are handled elsewhere.")
   (concat "\\(\\[?\\([ACHMS]-\\|kp-\\)+\\)[ \t\n\r\f]*\\(\\(<?\\<" 
kbd-key:named-key-regexp "\\>>?"
          "\\|<?[fF][0-9][0-9]?>?\\|<[a-zA-Z0-9]+>\\|.\\)\\]?\\)")
   "Regexp matching a single modified keyboard key within a human-readable 
string.
-Group 1 matches to the set of modifier keys.  Group 3 matches to the 
unmodified key.")
+Group 1 matches to the set of modifier keys.  Group 3 matches to
+the unmodified key.")
 
 ;;; ************************************************************************
 ;;; Public declarations
@@ -70,7 +71,7 @@ Group 1 matches to the set of modifier keys.  Group 3 matches 
to the unmodified
 ;;; ************************************************************************
 
 (defact kbd-key (key-series)
-  "Execute a normalized KEY-SERIES (series of key sequences) without curly 
braces, {}.
+  "Execute a normalized KEY-SERIES (series of key sequences) without curly 
braces.
 Each key sequence within KEY-SERIES must be a string of one of the following:
   a Hyperbole minibuffer menu item key sequence,
   a HyControl key sequence,
@@ -475,8 +476,9 @@ Allow for multiple key sequences strung together."
        t))
 
 (defun kbd-key:hyperbole-mini-menu-key-p (key-series)
-  "Return t if normalized KEY-SERIES appears to invoke a Hyperbole menu item 
or sequence of keys, else nil.
-Also, initialize `kbd-key:mini-menu-key' to the key sequence that invokes the 
Hyperbole minibuffer menu."
+  "Return non-nil if KEY-SERIES invoke a Hyperbole menu item or sequence of 
keys.
+KEY-SERIES is normalized.  Also, initialize `kbd-key:mini-menu-key' to the
+key sequence that invokes the Hyperbole minibuffer menu."
   (when (stringp key-series)
     (unless (and (stringp kbd-key:mini-menu-key) (not (string-empty-p 
kbd-key:mini-menu-key)))
       (setq kbd-key:mini-menu-key (regexp-quote (kbd-key:normalize 
(key-description (car (where-is-internal 'hyperbole)))))))
@@ -484,7 +486,8 @@ Also, initialize `kbd-key:mini-menu-key' to the key 
sequence that invokes the Hy
       t)))
 
 (defun kbd-key:key-and-arguments (key-series)
-  "Return t if normalized KEY-SERIES appears to be a bound key sequence 
possibly with following interactive arguments, else nil."
+  "Return t if normalized KEY-SERIES appears to be a bound key sequence, else 
nil.
+KEY-SERIES can have following interactive arguments."
   (let ((prefix-binding (and (stringp key-series) (kbd-key:binding (substring 
key-series 0 (seq-position key-series ?\ ))))))
     ;; Just ensure that 1st character is bound to something that is
     ;; not a self-insert-command or a number.
@@ -494,7 +497,7 @@ Also, initialize `kbd-key:mini-menu-key' to the key 
sequence that invokes the Hy
         t)))
 
 (defun kbd-key:mark-spaces-to-keep (string start-delim end-delim)
-  "Return STRING with all spaces between any START-DELIM string and END-DELIM 
string marked for non-replacement."
+  "Return STRING with all spaces between START-DELIM and END-DELIM marked to 
keep."
   (let ((regexp (format "\\(%s[^ \t\n\r\f]*\\)[ \t\n\r\f]\\(.*%s\\)"
                        start-delim end-delim))
        (start 0)
@@ -529,7 +532,8 @@ a M-x extended command,
 
 (defconst kbd-key:extended-command-prefix
   (format "\\_<%s\\_>" (kbd-key:normalize "M-x"))
-  "Normalized prefix regular expression that invokes an extended command; by 
default, M-x.")
+  "Normalized prefix regular expression that invokes an extended command.
+Default is M-x.")
 
 (defconst kbd-key:extended-command-binding-list '(execute-extended-command 
helm-M-x counsel-M-x)
   "List of commands that may be bound to M-x to invoke extended/named 
commands.")
diff --git a/hpath.el b/hpath.el
index 238c0a2250..94b14fa7d7 100644
--- a/hpath.el
+++ b/hpath.el
@@ -3,7 +3,7 @@
 ;; Author:       Bob Weiner
 ;;
 ;; Orig-Date:     1-Nov-91 at 00:44:23
-;; Last-Mod:      3-Oct-22 at 20:09:00 by Mats Lidell
+;; Last-Mod:      7-Oct-22 at 00:19:55 by Mats Lidell
 ;;
 ;; Copyright (C) 1991-2022  Free Software Foundation, Inc.
 ;; See the "HY-COPY" file for license information.
@@ -1790,7 +1790,8 @@ See the documentation of the `hpath:rfc' variable."
   (format hpath:rfc rfc-num))
 
 (defun hpath:start-end (path)
-  "If point is within the first line of PATH, return a list of its start and 
end positions (sans delimiters), else nil.
+  "Return a list of start and end positions in PATH (sans delimiters), else 
nil.
+Point must be within the first line of PATH.
 NOTE: This will return nil if the path has been normalized in any way
 \(adjusted for mount points or variables replaced) since the
 in-buffer path will not match."
diff --git a/hsys-org.el b/hsys-org.el
index 82a1e8dd58..c6014a046b 100644
--- a/hsys-org.el
+++ b/hsys-org.el
@@ -3,7 +3,7 @@
 ;; Author:       Bob Weiner
 ;;
 ;; Orig-Date:     2-Jul-16 at 14:54:14
-;; Last-Mod:      2-Aug-22 at 14:12:40 by Mats Lidell
+;; Last-Mod:      7-Oct-22 at 22:08:03 by Mats Lidell
 ;;
 ;; Copyright (C) 2016-2021  Free Software Foundation, Inc.
 ;; See the "HY-COPY" file for license information.
@@ -55,7 +55,7 @@
 
 ;;;###autoload
 (defcustom hsys-org-enable-smart-keys 'unset
-  "This option applies only in Org major/minor modes when hyperbole-mode is 
active.
+  "This applies in Org major/minor modes only when `hyperbole-mode' is active.
 If set to 'unset prior to loading Hyperbole, then Hyperbole
 initialization will set its value.
 
@@ -63,13 +63,13 @@ The following table shows what the Smart Keys do in various 
contexts
 with different settings of this option.  For example, a nil value makes
 {M-RET} operate as it normally does within Org mode contexts.
 
-|---------------------+-------------------+------------------+----------+------------------|
-| This Option Setting | Smart Key Context | Hyperbole Button | Org Link | 
Fallback Command |
-|---------------------+-------------------+------------------+----------+------------------|
-| buttons             | Ignore            | Activate         | Activate | 
org-meta-return  |
-| nil                 | Ignore            | Ignore           | Ignore   | 
org-meta-return  |
-| t                   | Activate          | Activate         | Activate | None 
            |
-|---------------------+-------------------+------------------+----------+------------------|"
+|---------+-------------------+------------------+----------+------------------|
+| Setting | Smart Key Context | Hyperbole Button | Org Link | Fallback Command 
|
+|---------+-------------------+------------------+----------+------------------|
+| buttons | Ignore            | Activate         | Activate | org-meta-return  
|
+| nil     | Ignore            | Ignore           | Ignore   | org-meta-return  
|
+| t       | Activate          | Activate         | Activate | None             
|
+|---------+-------------------+------------------+----------+------------------|"
   :type '(choice (const :tag "buttons - In Org, enable Smart Keys within 
Hyperbole buttons only" buttons)
                 (const :tag "nil     - In Org, disable Smart Keys entirely" 
nil)
                 (const :tag "t       - In Org, enable all Smart Key contexts" 
t))
@@ -82,7 +82,7 @@ with different settings of this option.  For example, a nil 
value makes
 
 ;;;###autoload
 (defvar hsys-org-mode-function #'hsys-org-mode-p
-  "*Boolean function of no arguments that determines whether point is in an 
Org mode-related buffer or not.")
+"*Zero arg bool func that returns non-nil if point is in an Org-related 
buffer.")
 
 ;;; ************************************************************************
 ;;; Public Action Types
@@ -190,7 +190,7 @@ Return the (start . end) buffer positions of the region."
        (org-get-at-bol 'org-marker)))
 
 (defun hsys-org-block-start-at-p ()
-  "Return non-nil if point is on the first line of an Org block definition, 
else nil."
+  "Return non-nil if point is on the first line of an Org block definition."
   (save-excursion
     (forward-line 0)
     (or (looking-at org-block-regexp)
diff --git a/hui-em-but.el b/hui-em-but.el
index 068d7f388d..ff61c82d16 100644
--- a/hui-em-but.el
+++ b/hui-em-but.el
@@ -3,7 +3,7 @@
 ;; Author:       Bob Weiner
 ;;
 ;; Orig-Date:    21-Aug-92
-;; Last-Mod:      2-Aug-22 at 19:31:16 by Mats Lidell
+;; Last-Mod:      7-Oct-22 at 00:17:10 by Mats Lidell
 ;;
 ;; Copyright (C) 1992-2022  Free Software Foundation, Inc.
 ;; See the "HY-COPY" file for license information.
@@ -36,7 +36,7 @@
 ;;; ************************************************************************
 
 (defcustom hproperty:but-highlight-flag t
-  "*Non-nil (default value) means highlight all explict buttons with 
`hproperty:but-face'."
+"*Non-nil (default) applies `hproperty:but-face' highlight to explicit 
buttons."
   :type 'boolean
   :group 'hyperbole-buttons)
 
diff --git a/hui-mini.el b/hui-mini.el
index e1b5a761fd..f63656c543 100644
--- a/hui-mini.el
+++ b/hui-mini.el
@@ -3,7 +3,7 @@
 ;; Author:       Bob Weiner
 ;;
 ;; Orig-Date:    15-Oct-91 at 20:13:17
-;; Last-Mod:      6-Oct-22 at 18:56:05 by Bob Weiner
+;; Last-Mod:      7-Oct-22 at 21:57:23 by Mats Lidell
 ;;
 ;; Copyright (C) 1991-2022  Free Software Foundation, Inc.
 ;; See the "HY-COPY" file for license information.
@@ -334,8 +334,8 @@ If on the menu name prefix or the last item, move to the 
first item."
 
 (defun hui:menu-item-keys (menu-alist)
   "Return ordered list of keys that activate Hypb minibuffer MENU-ALIST items.
-For each item, the key is either the first capital letter in item or if there 
are none,
-then its first character."
+For each item, the key is either the first capital letter in item
+or if there are none, then its first character."
   (mapcar (lambda (item)
            ;; Return either the first capital letter in item or if
            ;; none, then its first character.
diff --git a/hyrolo-demo.el b/hyrolo-demo.el
index 67e600e31c..8b7a2f3b00 100644
--- a/hyrolo-demo.el
+++ b/hyrolo-demo.el
@@ -3,7 +3,7 @@
 ;; Author:       Bob Weiner
 ;;
 ;; Orig-Date:     4-Nov-17 at 13:56:47
-;; Last-Mod:     27-Aug-22 at 15:35:52 by Bob Weiner
+;; Last-Mod:      7-Oct-22 at 00:16:24 by Mats Lidell
 ;;
 ;; Copyright (C) 2017-2022  Free Software Foundation, Inc.
 ;; See the "HY-COPY" file for license information.
@@ -32,7 +32,7 @@
 
 ;;;###autoload
 (defun hyrolo-demo-fgrep (string &optional max-matches)
-  "Display rolo entries in \"DEMO-ROLO.otl\" matching STRING or a logical 
sexpression.
+  "Display rolo entries in \"DEMO-ROLO.otl\" matching STRING or a logical sexp.
 Display to a maximum of optional prefix arg MAX-MATCHES.
 Each entry is displayed with all of its sub-entries.
 
diff --git a/hyrolo.el b/hyrolo.el
index 6b20059acc..b6e0b57ad7 100644
--- a/hyrolo.el
+++ b/hyrolo.el
@@ -3,7 +3,7 @@
 ;; Author:       Bob Weiner
 ;;
 ;; Orig-Date:     7-Jun-89 at 22:08:29
-;; Last-Mod:      6-Oct-22 at 23:16:06 by Bob Weiner
+;; Last-Mod:      7-Oct-22 at 22:03:04 by Mats Lidell
 ;;
 ;; Copyright (C) 1991-2022  Free Software Foundation, Inc.
 ;; See the "HY-COPY" file for license information.
@@ -1319,7 +1319,7 @@ Return number of matching entries found."
   (hyrolo-search-directories #'hyrolo-grep file-regexp dirs))
 
 (defun hyrolo-next-regexp-match (regexp headline-only)
-  "In a HyRolo source buffer, move past the next occurrence of REGEXP or 
return nil."
+  "In a HyRolo source buffer, move past next occurrence of REGEXP or return 
nil."
   (re-search-forward regexp
                     (when headline-only
                       (save-excursion (end-of-visible-line) (point)))