[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[elpa] externals/hyperbole b789bfa004 2/2: Merge branch 'master' of hype
|
From: |
ELPA Syncer |
|
Subject: |
[elpa] externals/hyperbole b789bfa004 2/2: Merge branch 'master' of hyperbole |
|
Date: |
Thu, 25 Aug 2022 17:57:43 -0400 (EDT) |
branch: externals/hyperbole
commit b789bfa00467a1cdbcf0d194249dd364983b73cf
Merge: d9f10a29ac f6a07eef0b
Author: Bob Weiner <rsw@gnu.org>
Commit: Bob Weiner <rsw@gnu.org>
Merge branch 'master' of hyperbole
---
ChangeLog | 23 ++++++++
hbut.el | 165 ++++++++++++++++++++++++++++++++---------------------
hhist.el | 9 +--
hib-doc-id.el | 9 +--
hib-kbd.el | 54 +++++++++++-------
hload-path.el | 9 ++-
hsys-youtube.el | 27 +++++----
hui-em-but.el | 10 ++--
hui-jmenu.el | 12 ++--
hyrolo-demo.el | 9 +--
kotl/kfile.el | 19 +++---
kotl/klabel.el | 26 +++++----
kotl/klink.el | 16 ++++--
kotl/kproperty.el | 12 ++--
kotl/kvspec.el | 7 ++-
set.el | 11 ++--
test/demo-tests.el | 2 +-
17 files changed, 260 insertions(+), 160 deletions(-)
diff --git a/ChangeLog b/ChangeLog
index 18d6a96218..ff46361c1e 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -42,6 +42,17 @@
the current line to check if at the start of a hyrolo entry;
don't do a reverse search any more.
+2022-08-14 Mats Lidell <matsl@gnu.org>
+
+* set.el:
+* hyrolo-demo.el:
+* hui-jmenu.el:
+* hui-em-but.el:
+* hsys-youtube.el: Shorten docs strings to be within 80 char limit.
+
+* hload-path.el (hload-path--make-directory-autoloads): Use
+ loaddefs-generate if available.
+
2022-08-11 Bob Weiner <rsw@gnu.org>
* kotl/kview.el (kview:outline-regexp): Add groupings to match
@@ -65,8 +76,20 @@
. and .. out since match to "\\.org$" already does. Also add
missing arguments to hyrolo-org and complete doc strings.
+2022-08-07 Mats Lidell <matsl@gnu.org>
+
+* kotl/kvspec.el: Shorten docs strings to be within 80 char limit.
+
2022-07-26 Mats Lidell <matsl@gnu.org>
+* kotl/kproperty.el:
+* kotl/klink.el:
+* kotl/klabel.el:
+* kotl/kfile.el:
+* hib-kbd.el:
+* hib-doc-id.el:
+* hhist.el:
+* hbut.el:
* kotl/kotl-orgtbl.el: Shorten docs strings to be within 80 char limit.
2022-07-25 Mats Lidell <matsl@gnu.org>
diff --git a/hbut.el b/hbut.el
index 98f8fe7617..723ef2bee3 100644
--- a/hbut.el
+++ b/hbut.el
@@ -204,7 +204,7 @@ Return nil if no matching button is found."
(defalias 'ebut:key-to-label #'hbut:key-to-label)
(defun ebut:label-p (&optional as-label start-delim end-delim pos-flag
two-lines-flag)
- "Return key for the Hyperbole explicit button label that point is within,
else nil.
+ "Return key for the explicit button label that point is within, else nil.
This is the normalized key form of the explicit button's label.
Assume point is within the first line of any button label. All
@@ -297,7 +297,7 @@ positions at which the button delimiter begins and ends."
(defalias 'map-ebut #'ebut:map)
(defun ebut:map (but-func &optional regexp-match include-delims)
- "Apply BUT-FUNC to the explicit buttons in the visible part of the current
buffer.
+ "Apply BUT-FUNC to the explicit buttons in the visible part of current
buffer.
If REGEXP-MATCH is non-nil, only buttons which match this argument are
considered.
@@ -322,7 +322,7 @@ move to the first occurrence of the button."
(goto-char (+ (match-beginning 0) (length ebut:start)))))
(defun ebut:operate (curr-label new-label)
- "Operate on and modify properties of a new or existing explicit button given
by CURR-LABEL.
+ "Operate on and modify properties of an explicit button given by CURR-LABEL.
When NEW-LABEL is non-nil, this is substituted for CURR-LABEL and the
associated button is modified. Otherwise, a new button is created.
@@ -431,7 +431,8 @@ button is found in the current buffer."
(defun ebut:program (label actype &rest args)
- "Programmatically create an explicit Hyperbole button at point from LABEL,
ACTYPE (action type), and optional actype ARGS.
+ "Programmatically create an explicit Hyperbole button at point.
+Create button from LABEL, ACTYPE (action type), and optional actype ARGS.
Insert LABEL text at point surrounded by <( )> delimiters, adding any
necessary instance number of the button after the LABEL. ACTYPE may
be a Hyperbole action type name (from defact) or an Emacs Lisp
@@ -461,9 +462,9 @@ For interactive creation, use `hui:ebut-create' instead."
(defun ebut:search (string out-buf &optional match-part)
"Write explicit button lines matching STRING to OUT-BUF.
-Search across all files into which the user has previously saved explicit
buttons.
-By default, find matches for whole button labels only; optional MATCH-PART
-enables partial matches."
+Search across all files into which the user has previously saved
+explicit buttons. By default, find matches for whole button
+labels only; optional MATCH-PART enables partial matches."
(let* ((buffers (mapcar (lambda (dir)
(expand-file-name hattr:filename dir))
(hbmap:dir-list)))
@@ -539,8 +540,10 @@ enables partial matches."
total))
(defun ebut:to (lbl-key)
- "Find the nearest explicit button with LBL-KEY (a label or label key) within
the visible portion of the current buffer.
-Leave point inside the button label. Return the symbol for the button, else
nil."
+ "Find the nearest explicit button with LBL-KEY (a label or label key).
+Search within the visible portion of the current buffer. Leave
+point inside the button label. Return the symbol for the button,
+else nil."
(unless lbl-key
(setq lbl-key (ebut:label-p nil nil nil nil t)))
(hbut:funcall (lambda (lbl-key _buffer _key-src)
@@ -639,7 +642,8 @@ Return entry deleted (a list of attribute values) or nil."
(hbut:delete lbl-key nil (gbut:file)))
(defun gbut:ebut-program (label actype &rest args)
- "Programmatically create a global explicit Hyperbole button at point from
LABEL, ACTYPE (action type), and optional actype ARGS.
+ "Programmatically create a global explicit Hyperbole button at point.
+Create button from LABEL, ACTYPE (action type), and optional actype ARGS.
Insert LABEL text at the end of the personal/global button file
surrounded by <( )> delimiters, adding any necessary instance
number of the button after the LABEL. ACTYPE may be a Hyperbole
@@ -658,11 +662,11 @@ For interactive creation, use `hui:gbut-create' instead."
(eval `(ebut:program ',label ',actype ,@args))))))
(defun gbut:file ()
- "Return the absolute filename that stores Hyperbole global buttons (those
accessed by name)."
+ "Return the absolute path for the global button (those accessed by name)
file."
(expand-file-name hbmap:filename hbmap:dir-user))
(defun gbut:get (&optional lbl-key)
- "Return global Hyperbole button symbol given by optional LBL-KEY if found in
(gbut:file).
+ "Return global button symbol given by optional LBL-KEY if found in
(gbut:file).
Retrieve any button data, convert into a button object and return a symbol
which references the button.
@@ -704,7 +708,8 @@ to two lines."
(hbut:label-p as-label start-delim end-delim pos-flag two-lines-flag)))
(defun gbut:to (lbl-key)
- "Find the global button with LBL-KEY (a label or label key) within the
visible portion of the global button file.
+ "Find the global button with LBL-KEY (a label or label key).
+Find it within the visible portion of the global button file.
Leave point inside the button label, if it has one.
Return the symbol for the button when found, else nil."
(when (file-readable-p (gbut:file))
@@ -881,7 +886,7 @@ Use the function, (hbut:max-len), to read the proper
value.")
(defun hbut:act (&optional hbut)
"Perform action for optional explicit or implicit Hyperbole button symbol
HBUT.
-Default is 'hbut:current."
+Default is `hbut:current'."
(interactive (list (hbut:get (hargs:read-match "Activate labeled Hyperbole
button: "
(nconc (ebut:alist)
(ibut:alist))
nil t nil 'hbut))))
@@ -1038,7 +1043,7 @@ Ignore email-related buffers."
label)
(defun hbut:delete (&optional lbl-key buffer key-src)
- "Delete explicit or labeled implicit Hyperbole button symbol given by
LBL-KEY and BUFFER.
+ "Delete explicit or labeled implicit button symbol given by LBL-KEY and
BUFFER.
KEY-SRC is given when retrieving global buttons and is the full source
pathname.
Return a symbol which references the button or nil if not deleted.
@@ -1053,7 +1058,8 @@ BUFFER defaults to the current buffer."
(ibut:delete lbl-key)))))
(defun hbut:funcall (func &optional lbl-key buffer key-src)
- "Move to an implicit button and return the result of calling FUNC with
optional argument values of LBL-KEY, BUFFER and KEY-SRC.
+ "Move to an implicit button and return the result of calling FUNC.
+Call FUNC with optional argument values of LBL-KEY, BUFFER and KEY-SRC.
The implicit button used is given by LBL-KEY (a label or label key)
within BUFFER or KEY-SRC (full path to global button file). Use
`save-excursion' around this call to prevent permanent movement of
@@ -1078,7 +1084,7 @@ point when desired."
(funcall func lbl-key buffer key-src))))
(defun hbut:get (&optional lbl-key buffer key-src)
- "Return explicit or labeled implicit Hyperbole button symbol given by
LBL-KEY and BUFFER.
+ "Return explicit or labeled implicit button symbol given by LBL-KEY and
BUFFER.
KEY-SRC is given when retrieving global buttons and is the full source
pathname.
Return a symbol which references the button or nil if not found.
@@ -1165,7 +1171,8 @@ represent the output of particular document formatters."
((current-buffer))))))
(defun hbut:key-src-set-buffer (src)
- "Set buffer to SRC, a buffer, buffer name, file, directory or symlink and
return SRC or nil if invalid."
+ "Set buffer to SRC, a buffer, buffer name, file, directory or symlink.
+Return SRC or nil if invalid."
(cond ((null src) nil)
((or (bufferp src) (get-buffer src))
(set-buffer src)
@@ -1268,9 +1275,10 @@ whitespace sequences with `_'."
(defun hbut:map (but-func &optional start-delim end-delim
regexp-match include-delims)
- "Apply BUT-FUNC to a set of Hyperbole buttons in the visible part of the
current buffer.
-The set of buttons are those whose labels are delimited by optional
START-DELIM and
-END-DELIM and that match any optional REGEXP-MATCH.
+ "Apply BUT-FUNC to a set of hbuttons in the visible part of the current
buffer.
+The set of buttons are those whose labels are delimited by
+optional START-DELIM and END-DELIM and that match any optional
+REGEXP-MATCH.
START-DELIM defaults to ebut:start; END-DELIM defaults to ebut:end.
If END-DELIM is a symbol, e.g. t, then treat START-DELIM as a regular
@@ -1318,7 +1326,9 @@ calls `hbut:modify-syntax'.")
;;;###autoload
(defun hbut:modify-syntax ()
- "Modify syntactic character pairs in hbut:syntax-table and
help-mode-syntax-table for use with implicit button activations."
+ "Modify syntactic character pairs in syntax tables.
+Modify `hbut:syntax-table' and `help-mode-syntax-table'. For use
+with implicit button activations."
;; Treat angle brackets as opening and closing delimiters for ease
;; of matching.
(mapc (lambda (syntax-table)
@@ -1331,7 +1341,7 @@ calls `hbut:modify-syntax'.")
nil)
(defun hbut:outside-comment-p ()
- "Return t if within a programming language buffer and prior regexp match is
outside a comment, else nil."
+ "True if in a programming mode and regexp match is outside a comment, else
nil."
(when (and (derived-mode-p 'prog-mode)
(not (eq major-mode 'lisp-interaction-mode))
(not (memq major-mode hui-select-markup-modes)))
@@ -1355,8 +1365,10 @@ calls `hbut:modify-syntax'.")
Takes an optional ARG interpreted as follows:
a button symbol - report on that button;
nil - report on button at point, if any;
- integer > 0 - report on all explicit buttons in buffer, in
lexicographical order;
- integer < 1 - report on all explicit buttons in buffer, in occurrence
order.
+ integer > 0 - report on all explicit buttons in buffer,
+ in lexicographical order;
+ integer < 1 - report on all explicit buttons in buffer,
+ in occurrence order.
Return number of buttons reported on or nil if none."
(setq arg (cond ((or (integerp arg) (symbolp arg)) arg)
@@ -1424,8 +1436,10 @@ If a file, always return a full path if optional FULL is
non-nil."
(defalias 'hbut:summarize 'hbut:report)
(defun hbut:to (lbl-key)
- "Find the nearest explicit button or labeled/named implicit button with
LBL-KEY (a label or label key) within the visible portion of the current buffer.
-Leave point inside the button label. Return the symbol for the button, else
nil."
+ "Find the nearest explicit button or labeled/named implicit button.
+Button given by LBL-KEY (a label or label key) and within the
+visible portion of the current buffer. Leave point inside the
+button label. Return the symbol for the button, else nil."
(or (ebut:to lbl-key) (ibut:to lbl-key)))
(defvar hbut:current nil
@@ -1447,7 +1461,8 @@ source file for the buttons in the menu, if any.")
(nconc (hbut:ebut-key-list) (hbut:ibut-key-list)))
(defun hbut:ebut-key-list (&optional key-src)
- "Return a list of explicit button label keys from optional KEY-SRC or the
current buffer."
+ "Return a list of explicit button label keys.
+Keys in optional KEY-SRC or the current buffer."
(save-excursion
(if (hbdata:to-entry-buf (or key-src (buffer-file-name)))
(let (hbuts)
@@ -1461,7 +1476,8 @@ source file for the buttons in the menu, if any.")
hbuts)))))
(defun hbut:ibut-key-list (&optional key-src)
- "Return a list of implicit button label keys from optional KEY-SRC or the
current buffer."
+ "Return a list of implicit button label keys.
+Keys in optional KEY-SRC or the current buffer."
(save-excursion
(when (hbut:key-src-set-buffer (or key-src (current-buffer)))
(save-restriction
@@ -1731,7 +1747,7 @@ expression which matches an entire button string."
(hbut:map but-func ibut:label-start ibut:label-end))
(defun ibut:rename (old-lbl new-lbl)
- "Rename a label preceding the text of a Hyperbole implicit button in the
current buffer from OLD-LBL to NEW-LBL.
+ "Change an implicit button name in the current buffer from OLD-LBL to
NEW-LBL.
Return t if the label is changed, else nil.
Signal an error when no such button is found in the current buffer.
@@ -1752,7 +1768,7 @@ current."
(t (error "(ibut:rename): Button '%s' not found in visible portion of
buffer." old-lbl))))
(defun ibut:label-p (&optional as-label start-delim end-delim pos-flag
two-lines-flag)
- "Return key for the Hyperbole implicit button label that point is within,
else nil.
+ "Return key for the implicit button label that point is within, else nil.
This is the normalized key form of an optional label that may
precede an implicit button. Use `ibut:at-p' instead to test if
point is on either the implicit button text itself or the label.
@@ -1770,12 +1786,14 @@ constrain label search to two lines."
(or end-delim ibut:label-end) pos-flag two-lines-flag)))
(defun ibut:label-regexp (lbl-key &optional no-delim)
- "Unnormalize ibutton LBL-KEY. Return regular expression matching delimited
button label.
+ "Unnormalize ibutton LBL-KEY.
+Return regular expression matching delimited button label.
Optional NO-DELIM leaves off delimiters, leading and trailing space."
(hbut:label-regexp lbl-key no-delim ibut:label-start ibut:label-end))
(defun ibut:label-set (label &optional start end)
- "Set current implicit button attributes from LABEL and optional START, END
positions.
+ "Set current implicit button attributes.
+Get attributes from LABEL and optional START, END positions.
Return label. When START and END are given, they specify the
region in the buffer to flash when this implicit button is
activated or queried for its attributes. If LABEL is a list, it
@@ -1829,9 +1847,9 @@ positions at which the button label delimiter begins and
ends."
(defun ibut:map (but-func &optional _start-delim _end-delim
regexp-match include-delims)
- "Apply BUT-FUNC to the labeled implicit buttons in the visible part of the
current buffer.
-If REGEXP-MATCH is non-nil, only buttons which match this argument are
-considered.
+ "Apply BUT-FUNC to the visible, named implicit buttons.
+If REGEXP-MATCH is non-nil, only buttons which match this argument
+are considered.
BUT-FUNC must take precisely three arguments: the button label, the
start position of the delimited button label and its end position (positions
@@ -1839,8 +1857,8 @@ include delimiters when INCLUDE-DELIMS is non-nil)."
(hbut:map but-func ibut:label-start ibut:label-end regexp-match
include-delims))
(defun ibut:next-occurrence (lbl-key &optional buffer)
- "Move point to next occurrence of an implicit button with LBL-KEY in
optional BUFFER.
-BUFFER defaults to current buffer. It may be a buffer name.
+ "Move point to next occurrence of an implicit button with LBL-KEY.
+Optional BUFFER defaults to current buffer. It may be a buffer name.
Return non-nil iff occurrence is found.
Remember to use (goto-char (point-min)) before calling this in order to
@@ -1854,8 +1872,8 @@ move to the first occurrence of the button."
(goto-char (+ (match-beginning 0) (length ibut:label-start)))))
(defun ibut:previous-occurrence (lbl-key &optional buffer)
- "Move point to previous occurrence of an implicit button with LBL-KEY in
optional BUFFER.
-BUFFER defaults to current buffer. It may be a buffer name.
+ "Move point to previous occurrence of an implicit button with LBL-KEY.
+Optional BUFFER defaults to current buffer. It may be a buffer name.
Return non-nil iff occurrence is found.
Remember to use (goto-char (point-max)) before calling this to search
@@ -1871,7 +1889,8 @@ the whole buffer."
(defalias 'ibut:summarize 'hbut:report)
(defun ibut:to (lbl-key)
- "Find the nearest implicit button with LBL-KEY (a label or label key) within
the visible portion of the current buffer.
+ "Find the nearest implicit button with LBL-KEY (a label or label key).
+Find within the visible portion of the current buffer.
Leave point inside the button text or its optional label, if it has one.
Return the symbol for the button, else nil."
(unless lbl-key
@@ -1917,9 +1936,9 @@ Return the symbol for the button, else nil."
lbl-key))
(defun ibut:at-to-name-p (&optional ibut)
- "If point is on an implicit button, optional IBUT, move to the start of its
name, if any (past opening delimiter).
-When found, set the name and lbl-key properties of IBUT.
-Return t if name is found, else nil."
+ "If point is on an implicit button, optional IBUT, move to the start of its
name.
+If name is found, leave point after its opening delimiter and set the name
+and lbl-key properties of IBUT. Return t if name is found, else nil."
(let ((opoint (point))
move-flag
name
@@ -1941,10 +1960,14 @@ Return t if name is found, else nil."
move-flag))
(defun ibut:to-name (lbl-key)
- "Find the nearest implicit button with LBL-KEY (a label or label key) within
the visible portion of the current buffer and move to the start of its
delimited button name (after opening delimiter).
-This will find an implicit button if point is within its name or text
-or if LBL-KEY is a name/name-key of an existing implicit button. It
-will not find other unnamed implicit buttons.
+ "Move to the name of the nearest named implicit button matching LBL-KEY.
+Find the nearest implicit button with LBL-KEY (a label or label
+key), within the visible portion of the current buffer and move
+to the start of its delimited button name (after opening
+delimiter). This will find an implicit button if point is within
+its name or text or if LBL-KEY is a name/name-key of an existing
+implicit button. It will not find other unnamed implicit
+buttons.
Return the symbol for the button if found, else nil."
(unless lbl-key
@@ -1970,10 +1993,13 @@ Return the symbol for the button if found, else nil."
lbl-key))
(defun ibut:to-text (lbl-key)
- "Find the nearest implicit button with LBL-KEY (a label or label key) within
the visible portion of the current buffer and move to within its button text.
-This will find an implicit button if point is within its name or text
-or if LBL-KEY is a name/name-key of an existing implicit button. It
-will not find other unnamed implicit buttons.
+ "Move to the text of the nearest implicit button matching LBL-KEY.
+Find the nearest implicit button with LBL-KEY (a label or label
+key) within the visible portion of the current buffer and move to
+within its button text. This will find an implicit button if
+point is within its name or text or if LBL-KEY is a name/name-key
+of an existing implicit button. It will not find other unnamed
+implicit buttons.
Return the symbol for the button if found, else nil."
(unless lbl-key
@@ -2021,11 +2047,14 @@ Return the symbol for the button if found, else nil."
"String matching the end of a Hyperbole implicit button label.")
(defvar ibut:label-separator " "
- "String inserted immediately after a newly created implicit button label to
separate it from the implicit button text.
-See also `ibut:label-separator-regexp' for all valid characters that may
manually inserted to separate an implicit button label from its text.")
+ "String inserted immediately after a newly created implicit button name.
+This separates it from the implicit button text. See also
+`ibut:label-separator-regexp' for all valid characters that may
+manually inserted to separate an implicit button label from its
+text.")
(defvar ibut:label-separator-regexp "\\s-*[-:=]*\\s-+"
- "Regular expression that separates an implicit button label from its
implicit button text.")
+ "Regular expression that separates an implicit button name from its button
text.")
;;; ========================================================================
;;; ibtype class - Implicit button types
@@ -2081,7 +2110,7 @@ type for ibtype is presently undefined."
(defalias 'ibtype:create #'defib)
(defun ibtype:activate-link (referent)
- "Activate a Hyperbole implicit link `referent', either a key series, a URL
or a path."
+ "Activate an implicit link REFERENT, either a key series, a url or a path."
(when referent
(let ((key-series (kbd-key:is-p referent)))
(if key-series
@@ -2094,7 +2123,10 @@ type for ibtype is presently undefined."
(defmacro defil (type start-delim end-delim text-regexp link-expr
&optional start-regexp-flag end-regexp-flag doc)
- "Create Hyperbole implicit button link type from: TYPE (an uquoted symbol),
START-DELIM and END-DELIM (strings), TEXT-REGEXP and LINK-EXPR.
+ "Create an implicit button link type.
+Use: TYPE (an unquoted symbol), START-DELIM and END-DELIM (strings),
+TEXT-REGEXP and LINK-EXPR.
+
With optional START-REGEXP-FLAG non-nil, START-DELIM is treated
as a regular expression. END-REGEXP-FLAG treats END-DELIM as a
regular expression. Hyperbole automatically creates a doc string
@@ -2119,8 +2151,8 @@ the whole button text (\\\\&) or any numbered grouping
from
TEXT-REGEXP, e.g. \\\\1, may be referenced in the LINK-EXPR to
form the link referent.
-Here is a sample use case. Let's create a button type whose
-buttons perform a grep-like function over a current repo's git
+Here is a sample use case. Create a button type whose buttons
+perform a grep-like function over a current repository's git
log entries. The buttons use this format: [<text to match>].
The following defines the button type called search-git-log which
@@ -2135,8 +2167,8 @@ an Action Key press on a button of the form:
;; [<test release>]
-will display one line per commit whose change set matches 'test
-release'. An Action Key press on any such line will then display the
+will display one line per commit whose change set matches \"test
+release\". An Action Key press on any such line will then display the
commit changes."
(declare (debug
(&define name stringp stringp stringp [&or stringp lambda-list]
@@ -2184,9 +2216,12 @@ commit changes."
(if (stringp ,link-expr) (regexp-quote ,link-expr)
,link-expr)))))))
(defmacro defal (type link-expr &optional doc)
- "Create Hyperbole action button link TYPE (an unquoted symbol) whose buttons
look like: <TYPE link-text> where link-text is substituted into LINK-EXPR as
grouping 1 (specified either as %s or \\\\1).
-Hyperbole automatically creates a doc string for the type but you can
-override this by providing an optional DOC string.
+ "Create an action button link TYPE (an unquoted symbol).
+The buttons look like: <TYPE link-text> where link-text is
+substituted into LINK-EXPR as grouping 1 (specified either as %s
+or \\\\1). Hyperbole automatically creates a doc string for the
+type but you can override this by providing an optional DOC
+string.
LINK-EXPR may be:
(1) a brace-delimited key series;
@@ -2241,7 +2276,7 @@ use `defib'."
(defun ibtype:def-symbol (ibtype)
"Return the abbreviated symbol for IBTYPE used in its `defib'.
-IBTYPE must be a symbol or string that begins with 'ibtype::' or nil
+IBTYPE must be a symbol or string that begins with `ibtype::' or nil
is returned."
(let ((name (if (stringp ibtype)
ibtype
diff --git a/hhist.el b/hhist.el
index ff2df4f7fe..c6340f91c4 100644
--- a/hhist.el
+++ b/hhist.el
@@ -3,9 +3,9 @@
;; Author: Bob Weiner
;;
;; Orig-Date: 24-Apr-91 at 03:36:23
-;; Last-Mod: 17-Apr-22 at 12:41:30 by Bob Weiner
+;; Last-Mod: 21-Jul-22 at 11:17:46 by Mats Lidell
;;
-;; Copyright (C) 1991-2021 Free Software Foundation, Inc.
+;; Copyright (C) 1991-2022 Free Software Foundation, Inc.
;; See the "HY-COPY" file for license information.
;;
;; This file is part of GNU Hyperbole.
@@ -25,8 +25,9 @@
;;; ************************************************************************
(defun hhist:add (elt)
- "Add ELT to hyper-history list if not the same as current or prior location
(frame configuration).
-ELT must have been created via a call to 'hhist:element' prior to
+ "Add ELT to hyper-history list.
+Do not add if the same as current or prior location (frame configuration).
+ELT must have been created via a call to `hhist:element' prior to
changing the current frame configuration somehow."
;; Even though this next line looks useless, it cures a problem with
;; window buffer correspondences on startup, so don't remove it.
diff --git a/hib-doc-id.el b/hib-doc-id.el
index b3acc50a98..028321c951 100644
--- a/hib-doc-id.el
+++ b/hib-doc-id.el
@@ -3,9 +3,9 @@
;; Author: Bob Weiner
;;
;; Orig-Date: 30-Sep-92 at 19:39:59
-;; Last-Mod: 24-Jan-22 at 00:18:32 by Bob Weiner
+;; Last-Mod: 21-Jul-22 at 11:21:45 by Mats Lidell
;;
-;; Copyright (C) 1991-2021 Free Software Foundation, Inc.
+;; Copyright (C) 1991-2022 Free Software Foundation, Inc.
;; See the "HY-COPY" file for license information.
;;
;; This file is part of GNU Hyperbole.
@@ -93,7 +93,7 @@
(concat "ID:[ \t]*"
(regexp-quote doc-id-start) "[ \t]*" (regexp-quote doc-id)
"[ \t]*" (regexp-quote doc-id-end)))
- "Function of one argument that returns regexp which matches only within
DOC-ID's index entry.")
+ "Single arg function returning regexp matching within DOC-ID's index entry
only.")
(defvar doc-id-p (lambda (str)
(and (stringp str)
@@ -103,7 +103,8 @@
"Value is a function with a boolean result that tests whether `str' is a doc
id.")
(defvar doc-id-online-regexp "^Online-Loc:[ \t]*\"\\([^\"\t\r\n\f]+\\)\""
- "Regexp whose 1st grouping matches a double quoted index entry implicit
button that displays an online document.")
+ "Regexp with 1st grouping matching a double quoted index entry implicit
button.
+The implicit button displays an online document.")
;;; ************************************************************************
;;; Public implicit button types
diff --git a/hib-kbd.el b/hib-kbd.el
index 1fdb10c57e..56c6a3789f 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: 15-Jul-22 at 23:21:33 by Mats Lidell
+;; Last-Mod: 21-Jul-22 at 11:40:53 by Mats Lidell
;;
;; Copyright (C) 1991-2022 Free Software Foundation, Inc.
;; See the "HY-COPY" file for license information.
@@ -44,19 +44,20 @@
"divide" "down" "end" "enter" "esc" "home" "left" "insert"
"multiply" "newline" "next" "prior" "return" "ret" "right" "rtn"
"subtract" "tab" "up")
- "List of dedicated keyboard key names which may be used with modifier keys.
Function keys are handled elsewhere.")
+ "List of dedicated keyboard key names which may be used with modifier keys.
+Function keys are handled elsewhere.")
(defvar kbd-key:named-key-regexp
(concat
(mapconcat 'downcase kbd-key:named-key-list "\\|")
"\\|"
(mapconcat 'upcase kbd-key:named-key-list "\\|"))
- "Regexp that matches to any of the dedicated keyboard key names in lower or
uppercase.")
+ "Regexp that matches the dedicated keyboard key names in lower or
uppercase.")
(defvar kbd-key:modified-key-regexp
(concat "\\(\\[?\\([ACHMS]-\\|kp-\\)+\\)[ \t\n\r\f]*\\(\\(<?\\<"
kbd-key:named-key-regexp "\\>>?"
"\\|<?[fF][0-9][0-9]?>?\\|<[a-zA-Z0-9]+>\\|.\\)\\]?\\)")
- "Regexp matching to a single modified keyboard key within a human-readable
string.
+ "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.")
;;; ************************************************************************
@@ -81,9 +82,11 @@ Return t if the sequence appears to be valid, else nil."
(kbd-key:act key-series))
(defib kbd-key ()
- "Execute a key series (series of key sequences) around point, delimited by
curly braces, {}.
-Key sequences should be in human readable form, e.g. {C-x C-b}, or what
`key-description' returns.
-Forms such as {\C-b}, {\^b}, and {^M} will not be recognized.
+ "Execute a key series (series of key sequences) around point.
+The key series is delimited by curly braces, {}. Key sequences
+should be in human readable form, e.g. {C-x C-b}, or what
+`key-description' returns. Forms such as {\C-b}, {\^b}, and {^M}
+will not be recognized.
Any key sequence within the series must be a string of one of the following:
a Hyperbole minibuffer menu item key sequence,
@@ -163,7 +166,8 @@ Return t if KEY-SERIES appears valid, else nil."
t))))
(defun kbd-key:execute (key-series)
- "Execute a possibly non-normalized KEY-SERIES with or without curly brace
delimiters.
+ "Execute a possibly non-normalized KEY-SERIES.
+The KEY-SERIES can be with or without curly brace delimiters.
Return t if KEY-SERIES is a valid key series that is executed, else nil."
(interactive "sKey series to execute: ")
(when (and key-series
@@ -189,13 +193,15 @@ Return t if KEY-SERIES is a valid key series that is
executed, else nil."
helm-flag orig-binding))))))
(defun kbd-key:maybe-enable-helm (helm-flag orig-M-x-binding)
- "Enable helm-mode if HELM-FLAG is non-nil. Restore M-x binding to
ORIG-M-X-BINDING."
+ "Enable helm-mode if HELM-FLAG is non-nil.
+Restore M-x binding to ORIG-M-X-BINDING."
(when helm-flag (helm-mode 1))
(global-set-key [?\M-x] orig-M-x-binding))
(defun kbd-key:key-series-to-events (key-series)
- "Insert the key-series as a series of keyboard events into Emacs' unread
input stream.
-Emacs then executes them when its command-loop regains control."
+ "Insert the key-series as a series of keyboard events.
+The events are inserted into Emacs unread input stream. Emacs
+then executes them when its command-loop regains control."
(setq unread-command-events (nconc unread-command-events
(listify-key-sequence
(kbd-key:kbd key-series)))))
@@ -233,9 +239,12 @@ With optional prefix arg FULL, display full documentation
for command."
(kbd-key:doc kbd-key t))))
(defun kbd-key:is-p (str)
- "If STR is a curly-brace {} delimited key series, return the non-delimited,
normalized form, else nil.
-Key sequences should be in human readable form, e.g. {C-x C-b}, or what
`key-description' returns.
-Forms such as {\C-b}, {\^b}, and {^M} will not be recognized.
+ "Return the non-delimited, normalized form, of a delimited key series, STR.
+When STR is a curly-brace {} delimited key series, a
+non-delimited, normalized form is returned, else nil. Key
+sequences should be in human readable form, e.g. {C-x C-b}, or
+what `key-description' returns. Forms such as {\C-b}, {\^b}, and
+{^M} will not be recognized.
Any key sequence within the series must be a string of one of the following:
a Hyperbole minibuffer menu item key sequence,
@@ -264,9 +273,10 @@ Any key sequence within the series must be a string of one
of the following:
key-series)))
(defun kbd-key:normalize (key-series)
- "Normalize a human-readable string of keyboard keys, KEY-SERIES (without any
surrounding {}).
-Return the normalized but still human-readable format.
-Use `kbd-key:key-series-to-events' to add the key series to Emacs'
+ "Normalize a human-readable string of keyboard keys, KEY-SERIES.
+The KEY-SERIES is without any surrounding {}. Return the
+normalized but still human-readable format. Use
+`kbd-key:key-series-to-events' to add the key series to Emacs'
keyboad input queue, as if they had been typed by the user."
(interactive "kKeyboard key sequence to normalize (no {}): ")
;;
@@ -327,7 +337,8 @@ keyboad input queue, as if they had been typed by the user."
(t (error "(kbd-key:normalize): requires a string argument, not `%s'"
key-series))))
(defun kbd-key:remove-delimiters (str start-delim end-delim)
- "Return STR sans START-DELIM and END-DELIM (strings) iff it starts and ends
with these delimiters."
+ "Return STR sans START-DELIM and END-DELIM (strings).
+Return nil if STR does not start and end with the given delimiters."
(when (and (string-match (format "\\`%s" (regexp-quote start-delim)) str)
(string-match (format "%s\\'" (regexp-quote end-delim)) str))
(string-trim str start-delim end-delim)))
@@ -447,13 +458,14 @@ For an approximate inverse of this, see
`key-description'."
res)))
(defun kbd-key:extended-command-p (key-series)
- "Return non-nil if the string KEY-SERIES is a normalized extended command
invocation, i.e. M-x command."
+ "Return non-nil if the KEY-SERIES is a normalized extended command
invocation.
+That is, 'M-x command'."
(when (stringp key-series)
(string-match kbd-key:extended-command-prefix key-series)))
(defun kbd-key:hyperbole-hycontrol-key-p (key-series)
- "Return t if normalized, non-nil KEY-SERIES is given when in a HyControl
mode, else nil.
-Allows for multiple key sequences strung together."
+ "Return t if KEY-SERIES is normalized, non-nil and in HyControl mode, else
nil.
+Allow for multiple key sequences strung together."
(and key-series
(featurep 'hycontrol)
(or hycontrol-windows-mode hycontrol-frames-mode)
diff --git a/hload-path.el b/hload-path.el
index e4a13abee5..757223712f 100644
--- a/hload-path.el
+++ b/hload-path.el
@@ -111,9 +111,12 @@ the symbol list. For `suspicious', only `set-buffer' can
be used."
;; New autoload generation function defined only in Emacs 28
(defalias 'hload-path--make-directory-autoloads
- (if (fboundp #'make-directory-autoloads)
- #'make-directory-autoloads
- #'hload-path--internal-make-directory-autoloads))
+ (cond ((fboundp 'loaddefs-generate)
+ #'loaddefs-generate)
+ ((fboundp #'make-directory-autoloads)
+ #'make-directory-autoloads)
+ (t
+ #'hload-path--internal-make-directory-autoloads)))
(defun hload-path--internal-make-directory-autoloads (dir output-file)
"Update autoload definitions for Lisp files in the directories DIRS.
diff --git a/hsys-youtube.el b/hsys-youtube.el
index 3b66d90ebb..318177f618 100644
--- a/hsys-youtube.el
+++ b/hsys-youtube.el
@@ -3,7 +3,7 @@
;; Author: Bob Weiner
;;
;; Orig-Date: 10-Jul-22 at 18:10:56
-;; Last-Mod: 17-Jul-22 at 22:49:58 by Bob Weiner
+;; Last-Mod: 2-Aug-22 at 14:50:45 by Mats Lidell
;;
;; Copyright (C) 2022 Free Software Foundation, Inc.
;; See the "HY-COPY" file for license information.
@@ -72,7 +72,7 @@ optional.")
;;; ************************************************************************
(defun hsys-youtube-get-url (video-id &optional start-time-string
end-time-string)
- "Return the url to play VIDEO-ID from the point specified by optional
START-TIME-STRING.
+ "Return url to play VIDEO-ID from point specified by optional
START-TIME-STRING.
Return nil if START-TIME-STRING is given but is invalid. If not given,
START-TIME-STRING is set to \"0s\" representing the beginning of the video.
@@ -88,7 +88,7 @@ minutes are optional."
(hsys-youtube-start-url video-id start-time-string)))
(defun hsys-youtube-get-url:help (hbut)
- "Display in the minibuffer the url from an `hsys-youtube-get-url' action
button, HBUT.
+ "Show in minibuffer the url from an `hsys-youtube-get-url' action button,
HBUT.
Called when the Assist Key is pressed on such a button."
(message (apply #'hsys-youtube-get-url (hattr:get hbut 'args))))
@@ -116,7 +116,7 @@ and minutes are optional."
(hact #'actypes::www-url (hsys-youtube-get-url video-id start-time-string
end-time-string)))
(defun hsys-youtube-play:help (hbut)
- "Display in the minibuffer the url for an `hsys-youtube-play' action button,
HBUT.
+ "Show in the minibuffer the url for an `hsys-youtube-play' action button,
HBUT.
Called when the Assist Key is pressed on such a button."
(message (apply #'hsys-youtube-get-url (hattr:get hbut 'args))))
@@ -138,8 +138,9 @@ Called when the Assist Key is pressed on such a button."
;;; ************************************************************************
(defun hsys-youtube-end-url (video-id &optional start-time-string
end-time-string)
- "Return a URL to play a youtube VIDEO-ID from optional START-TIME-STRING
through END-TIME-STRING.
-VIDEO-ID must be a string and can be a video identifier, e.g. WkwZHSbHmPg, or
a full url to the video."
+ "Return url to play VIDEO-ID from optional START-TIME-STRING to
END-TIME-STRING.
+VIDEO-ID must be a string and can be a video identifier,
+e.g. WkwZHSbHmPg, or a full url to the video."
(if (or (null video-id)
(not (stringp video-id))
(string-empty-p video-id))
@@ -162,9 +163,9 @@ VIDEO-ID must be a string and can be a video identifier,
e.g. WkwZHSbHmPg, or a
(random 10000000))))
(defun hsys-youtube-start-url (video-id &optional start-time-string)
- "Return a URL to a youtube VIDEO-ID starting at optional START-TIME-STRING
or the beginning.
+ "Return url to play VIDEO-ID starting at beginning or optional
START-TIME-STRING.
VIDEO-ID must be a string and can be a video identifier,
-e.g. WkwZHSbHmPg, or a full url to the video."
+e.g. WkwZHSbHmPg, or a full url to the video."
(if (or (null video-id)
(not (stringp video-id))
(string-empty-p video-id))
@@ -179,7 +180,8 @@ e.g. WkwZHSbHmPg, or a full url to the video."
(format hsys-youtube-start-format video-id start-time-string))))
(defun hsys-youtube-time-in-hms (start-time-string)
- "Return the start time in hours, minutes, seconds for a Youtube url from
START-TIME-STRING.
+ "Return the start time for a Youtube url from START-TIME-STRING.
+Start time is returned as hours, minutes and seconds.
Hours and minutes are optional within the START-TIME-STRING, e.g. 1:2:44 (1
hour, two minutes, 45 seconds into a video). If the START-TIME-STRING
format is invalid, return it unchanged."
@@ -202,9 +204,10 @@ format is invalid, return it unchanged."
(defun hsys-youtube-time-in-seconds (start-time-string)
"Return the number of seconds time for a Youtube url given a
START-TIME-STRING.
-Hours and minutes are optional within the START-TIME-STRING, e.g. 1:2:44 (1
-hour, two minutes, 45 seconds into a video). The formats 1h2m44s or 1h:2m:44s
-may also be used. If the START-TIME-STRING format is invalid, return it
unchanged."
+Hours and minutes are optional within the START-TIME-STRING,
+e.g. 1:2:44 (1 hour, two minutes, 45 seconds into a video). The
+formats 1h2m44s or 1h:2m:44s may also be used. If the
+START-TIME-STRING format is invalid, return it unchanged."
(if (and (stringp start-time-string)
(string-match-p "[:hmsHMS]" start-time-string))
(let* ((time-parts (split-string start-time-string "[:hmsHMS]" t))
diff --git a/hui-em-but.el b/hui-em-but.el
index 638eb2da93..068d7f388d 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: 14-Jun-22 at 21:22:39 by Mats Lidell
+;; Last-Mod: 2-Aug-22 at 19:31:16 by Mats Lidell
;;
;; Copyright (C) 1992-2022 Free Software Foundation, Inc.
;; See the "HY-COPY" file for license information.
@@ -228,7 +228,9 @@ highlighted."
;;; ************************************************************************
(defun hproperty:cycle-but-color (&optional color)
- "Switch button color to optional COLOR name or next item referenced by
hproperty:color-ptr."
+ "Switch button color.
+Set color to optional COLOR name or next item referenced by
+hproperty:color-ptr."
(interactive "sHyperbole button color: ")
(when (display-color-p)
(when color (setq hproperty:color-ptr nil))
@@ -269,7 +271,7 @@ highlighted."
(and ibut (not prev) (hproperty:but-delete start))))
(defun hproperty:select-item (&optional pnt)
- "Select item in current buffer at optional position PNT using
hproperty:item-face."
+ "Select item in current buffer at optional position PNT with
hproperty:item-face."
(when pnt (goto-char pnt))
(skip-chars-forward " \t")
(skip-chars-backward "^ \t\n\r")
@@ -280,7 +282,7 @@ highlighted."
(sit-for 0)) ;; Force display update
(defun hproperty:select-line (&optional pnt)
- "Select line in current buffer at optional position PNT using
hproperty:item-face."
+ "Select line in current buffer at optional position PNT with
hproperty:item-face."
(when pnt (goto-char pnt))
(save-excursion
(beginning-of-line)
diff --git a/hui-jmenu.el b/hui-jmenu.el
index 38bfb9b6da..54fba061f1 100644
--- a/hui-jmenu.el
+++ b/hui-jmenu.el
@@ -3,7 +3,7 @@
;; Author: Bob Weiner
;;
;; Orig-Date: 9-Mar-94 at 23:37:28
-;; Last-Mod: 24-Jan-22 at 00:18:47 by Bob Weiner
+;; Last-Mod: 2-Aug-22 at 19:50:39 by Mats Lidell
;;
;; Copyright (C) 1994-2021 Free Software Foundation, Inc.
;; See the "HY-COPY" file for license information.
@@ -106,7 +106,8 @@
;;;###autoload
(defun hui-menu-jump-to-buffer ()
- "Popup a menu of existing buffers categorized by mode name. Jump to chosen
buffer."
+ "Popup a menu of existing buffers categorized by mode name.
+Jump to chosen buffer."
(interactive)
(popup-menu (cons "Jump to Buffer" (cdr (hui-menu-of-buffers)))))
@@ -197,7 +198,8 @@
(error "(Hyperbole): `%s' window no longer exists" (buffer-name
(window-buffer window)))))
(defun hui-menu-sort-buffers (buffer-and-mode-name-list)
- "Reverse sort and return list of (`buffer-name' . `mode-name') elements by
`mode-name' and then by `buffer-name'."
+ "Return reverse sort of BUFFER-AND-MODE-NAME-LIST, (`buffer-name' .
`mode-name').
+Reverse sort elements by `mode-name' and then by `buffer-name'."
(with-temp-buffer
(setq buffer-read-only nil)
(erase-buffer)
@@ -285,7 +287,7 @@ the minibuffer window even if it is active."
(or (hui-menu-edit-server-finish) (kill-buffer)))
(defun hui-menu-delete-buffer-and-window ()
- "Delete the current buffer and window, handling Emacs edit server frames
properly."
+ "Delete current buffer and window, handling Emacs edit server frames
properly."
(interactive)
(or (hui-menu-edit-server-finish)
(progn (kill-buffer) (delete-window))))
@@ -296,7 +298,7 @@ the minibuffer window even if it is active."
(or (hui-menu-edit-server-finish) (delete-frame)))
(defun hui-menu-move-window-to-new-frame ()
- "Delete the selected window if possible and display its buffer in a newly
selected frame.
+ "Delete the selected window and display its buffer in a newly selected frame.
The window is deleted only if there are two or more windows in the selected
frame. The current buffer is buried in the old frame's buffer list."
(interactive)
diff --git a/hyrolo-demo.el b/hyrolo-demo.el
index 82a10ee8c3..6b6bd9caa5 100644
--- a/hyrolo-demo.el
+++ b/hyrolo-demo.el
@@ -3,9 +3,9 @@
;; Author: Bob Weiner
;;
;; Orig-Date: 4-Nov-17 at 13:56:47
-;; Last-Mod: 24-Jan-22 at 00:23:34 by Bob Weiner
+;; Last-Mod: 6-Aug-22 at 21:33:05 by Mats Lidell
;;
-;; Copyright (C) 2017-2021 Free Software Foundation, Inc.
+;; Copyright (C) 2017-2022 Free Software Foundation, Inc.
;; See the "HY-COPY" file for license information.
;;
;; This file is part of GNU Hyperbole.
@@ -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
match expression).
+ "Display rolo entries in \"DEMO-ROLO.otl\" matching STRING or a logic
expression.
Display to a maximum of optional prefix arg MAX-MATCHES.
Each entry is displayed with all of its sub-entries.
@@ -49,7 +49,8 @@ logical expression matching."
;;;###autoload
(defun hyrolo-demo-fgrep-logical (expr &optional count-only
include-sub-entries no-sub-entries-out)
- "Display rolo entries in \"DEMO-ROLO.otl\" matching EXPR which may contain
prefix logical operators.
+ "Display rolo entries in \"DEMO-ROLO.otl\" matching EXPR.
+EXPR may contain prefix logical operators.
If optional COUNT-ONLY is non-nil, don't display entries, return
count of matching entries only. If optional INCLUDE-SUB-ENTRIES
flag is non-nil, SEXP will be applied across all sub-entries at
diff --git a/kotl/kfile.el b/kotl/kfile.el
index da3348d6f4..76df8858f3 100644
--- a/kotl/kfile.el
+++ b/kotl/kfile.el
@@ -3,9 +3,9 @@
;; Author: Bob Weiner
;;
;; Orig-Date: 10/31/93
-;; Last-Mod: 5-Jun-22 at 17:59:19 by Bob Weiner
+;; Last-Mod: 22-Jul-22 at 15:17:31 by Mats Lidell
;;
-;; Copyright (C) 1993-2021 Free Software Foundation, Inc.
+;; Copyright (C) 1993-2022 Free Software Foundation, Inc.
;; See the "../HY-COPY" file for license information.
;;
;; This file is part of GNU Hyperbole.
@@ -66,7 +66,9 @@ Return the new kview."
;;;###autoload
(defun kfile:is-p ()
- "Iff current buffer contains an unformatted or formatted koutline, return
file format version string, else nil."
+ "Iff current buffer contains a koutline, return file format version string.
+If not a koutline, return nil. This works both for unformatted
+and formatted koutlines."
(let (ver-string)
(save-excursion
(save-restriction
@@ -100,8 +102,8 @@ Return the new kview."
;;; ************************************************************************
(defun kfile:create (buffer)
- "Create a new koutline file attached to BUFFER, with a single empty level 1
kotl cell.
-Return file's kview."
+ "Create a new koutline file attached to BUFFER and return file's kview.
+File is created with a single empty level 1 kotl cell."
(or buffer (setq buffer (current-buffer)))
(unless (bufferp buffer)
(error "(kfile:create): Invalid buffer argument, %s" buffer))
@@ -156,9 +158,10 @@ Return file's kview."
view))
(defun kfile:read (buffer existing-file-p &optional ver-string)
- "Create a new kotl view by reading BUFFER or create an empty view when
EXISTING-FILE-P is nil.
-Optional VER-STRING is the outline format version number for the BUFFER that
-was previously read by calling `kfile:is-p'.
+ "Create a new kotl view by reading BUFFER.
+Create an empty view when EXISTING-FILE-P is nil. Optional
+VER-STRING is the outline format version number for the BUFFER
+that was previously read by calling `kfile:is-p'.
Return the new view."
(cond ((not (bufferp buffer))
diff --git a/kotl/klabel.el b/kotl/klabel.el
index bcd9dbd680..9e94ae89dc 100644
--- a/kotl/klabel.el
+++ b/kotl/klabel.el
@@ -3,7 +3,7 @@
;; Author: Bob Weiner
;;
;; Orig-Date: 17-Apr-94
-;; Last-Mod: 17-Jul-22 at 11:13:30 by Mats Lidell
+;; Last-Mod: 18-Jul-22 at 21:58:23 by Mats Lidell
;;
;; Copyright (C) 1994-2022 Free Software Foundation, Inc.
;; See the "../HY-COPY" file for license information.
@@ -44,7 +44,8 @@
(funcall (kview:get-attr kview 'label-increment) label))
(defun klabel:format (label)
- "Format a generic cell LABEL (a string) and return it in the proper display
type for the current kview."
+ "Format a generic cell LABEL (a string) and return the display type.
+Return the proper display type for the current kview."
(let ((label-type (or (kview:get-attr kview 'label-type)
kview:default-label-type)))
(cond ((memq label-type '(alpha id legal partial-alpha))
label)
@@ -90,8 +91,10 @@
label-type))))
(defun klabel-type:increment (label-type)
- "Return a function that takes a single label argument and computes the next
cell label of LABEL-TYPE.
-If the label is \"0\", its first child is computed, otherwise, the next
sibling is computed."
+ "Return a function and compute the next cell label of LABEL-TYPE.
+The function takes a single label argument. If the label is
+\"0\", its first child is computed, otherwise, the next sibling
+is computed."
(cond ((memq label-type '(alpha legal partial-alpha))
(intern-soft (concat "klabel:increment-" (symbol-name label-type))))
((eq label-type 'no)
@@ -255,11 +258,13 @@ First visible outline cell is level 1."
;;
(defun klabel-type:function (&optional label-type)
"Return function which will return display label for current cell.
-Label format is optional LABEL-TYPE or the default label type for the current
view.
+Label format is optional LABEL-TYPE or the default label type for
+the current view.
-Function signature is: (func prev-label &optional child-p), where prev-label
-is the display label of the cell preceding the current one and child-p is
-non-nil if cell is to be the child of the preceding cell."
+Function signature is: (func prev-label &optional child-p), where
+prev-label is the display label of the cell preceding the current
+one and child-p is non-nil if cell is to be the child of the
+preceding cell."
(or label-type (setq label-type (kview:label-type kview)))
(cond ((eq label-type 'no)
(lambda (_prev-label &optional _child-p)
@@ -478,7 +483,7 @@ and the start of its contents."
(kcell-view:next nil lbl-sep-len)))))
(defun klabel-type:update-labels (current-cell-label)
- "Update the labels of current cell, its following siblings and their
subtrees if need be.
+ "Update the labels of current cell, its following siblings and their
subtrees.
CURRENT-CELL-LABEL is the label to display for the current cell.
If, however, it is \"0\", then all cell labels are updated."
(let ((label-type (kview:label-type kview)))
@@ -615,7 +620,8 @@ N may be an integer or a string containing an integer."
;;; ************************************************************************
(defun klabel:set (new-label &optional lbl-sep-len)
- "Replace label displayed in cell at point with NEW-LABEL, which may be a
different label type.
+ "Replace label displayed in cell at point with NEW-LABEL.
+The new label type may differ from the old type.
Return NEW-LABEL string."
(let ((modified (buffer-modified-p))
(buffer-read-only)
diff --git a/kotl/klink.el b/kotl/klink.el
index f2df4729ed..8ef29cfeb3 100644
--- a/kotl/klink.el
+++ b/kotl/klink.el
@@ -3,7 +3,7 @@
;; Author: Bob Weiner
;;
;; Orig-Date: 15-Nov-93 at 12:15:16
-;; Last-Mod: 15-Jul-22 at 23:24:53 by Mats Lidell
+;; Last-Mod: 18-Jul-22 at 21:50:46 by Mats Lidell
;;
;; Copyright (C) 1993-2022 Free Software Foundation, Inc.
;; See the "../HY-COPY" file for license information.
@@ -85,9 +85,12 @@
;;; ************************************************************************
(defun klink:absolute (label-and-pos)
- "With point in a klink's source buffer and LABEL-AND-POS a list of
(klink-label, klink-start, klink-end) including delimiters, return an absolute
klink string.
-Klink is of the form: \"<absolute-file-name, cell-ref>\".
-See documentation for `kcell:ref-to-id' for valid cell-ref formats."
+ "Return an absolute klink string from LABEL-AND-POS list.
+With point in a klink's source buffer and LABEL-AND-POS a list
+of (klink-label, klink-start, klink-end) including delimiters,
+return an absolute klink string. Klink returned is of the form:
+\"<absolute-file-name, cell-ref>\". See documentation for
+`kcell:ref-to-id' for valid cell-ref formats."
(when (and (derived-mode-p 'kotl-mode) label-and-pos (listp label-and-pos))
(let* ((file-and-cell-ref (klink:parse (car label-and-pos)))
(file (or (car file-and-cell-ref) buffer-file-name))
@@ -199,8 +202,9 @@ link-end-position, (including delimiters)."
label-and-pos)))
(defun klink:set-yank-handler (klink)
- "Add yank-handler to KLINK so link is made relative when yanked into the
same koutline or the same directory.
-Return the modified KLINK."
+ "Add yank-handler to KLINK and return the modified KLINK.
+Link is made relative when yanked into the same koutline or the
+same directory."
(add-text-properties 0 (length klink)
(list 'yank-handler '(klink:yank-handler)
'yank-excluded-properties (cons 'yank-handler
(get-text-property 0 'yank-excluded-properties klink)))
diff --git a/kotl/kproperty.el b/kotl/kproperty.el
index 272b5b9135..75db9fac5b 100644
--- a/kotl/kproperty.el
+++ b/kotl/kproperty.el
@@ -37,7 +37,8 @@
plist))
(defun kproperty:all-positions (property value)
- "Return a list of all non-narrowed buffer positions of kcells with PROPERTY
set to VALUE, else nil.
+ "Return a list of all non-narrowed positions of kcells with PROPERTY VALUE.
+If no kcells with PROPERTY VALUE, return nil.
Use (kcell-view:start <position>) on each returned <position> to get
the start position of each cell's content."
(kproperty:map (lambda (start _end) start) property value))
@@ -45,9 +46,9 @@ the start position of each cell's content."
(defalias 'kproperty:get 'get-text-property)
(defun kproperty:map (function property value)
- "Apply FUNCTION to each character with PROPERTY `eq' to VALUE in the current
buffer.
-FUNCTION is called with the start and end points of the text span with the
matching PROPERTY
-and with point at the start."
+ "Apply FUNCTION to each character with PROPERTY VALUE in the current buffer.
+FUNCTION is called with the start and end points of the text span,
+with the matching PROPERTY and with point at the start."
(let ((result)
(start (point-min))
end)
@@ -63,7 +64,8 @@ and with point at the start."
(defalias 'kproperty:next-single-change 'next-single-property-change)
(defun kproperty:position (property value)
- "Return the non-narrowed buffer position of the first kcell with PROPERTY
set to VALUE, else nil.
+ "Return the non-narrowed buffer position of the first kcell with PROPERTY
VALUE.
+If no kcell with PROPERTY VALUE, return nil.
Use (kcell-view:start <position>) on the returned <position> to get
the start position of the cell's content."
(text-property-any (point-min) (point-max) property value))
diff --git a/kotl/kvspec.el b/kotl/kvspec.el
index 7d63699902..31864dfa34 100644
--- a/kotl/kvspec.el
+++ b/kotl/kvspec.el
@@ -3,7 +3,7 @@
;; Author: Bob Weiner
;;
;; Orig-Date: 21-Oct-95 at 15:17:07
-;; Last-Mod: 16-Jul-22 at 22:33:26 by Mats Lidell
+;; Last-Mod: 18-Jul-22 at 21:57:01 by Mats Lidell
;;
;; Copyright (C) 1995-2022 Free Software Foundation, Inc.
;; See the "../HY-COPY" file for license information.
@@ -255,8 +255,9 @@ view specs."
(kview:set-label-type kview type))))
(defun kvspec:show-lines-this-cell (num)
- "Assume the current cell is fully expanded and collapse to show NUM lines
within it.
-If NUM is less than 1 or greater than the number of lines available, the cell
remains fully expanded."
+ "Assume current cell is fully expanded and collapse to show NUM lines within
it.
+If NUM is less than 1 or greater than the number of lines
+available, the cell remains fully expanded."
;; Use free variable kview-label-sep-len bound in kview:map-* for speed.
(unless (< num 1)
(let ((_start (goto-char (kcell-view:start (point) kview-label-sep-len)))
diff --git a/set.el b/set.el
index da719bf365..e3daca9990 100644
--- a/set.el
+++ b/set.el
@@ -3,9 +3,9 @@
;; Author: Bob Weiner
;;
;; Orig-Date: 26-Sep-91 at 19:24:19
-;; Last-Mod: 12-Feb-22 at 10:42:19 by Mats Lidell
+;; Last-Mod: 6-Aug-22 at 23:23:08 by Mats Lidell
;;
-;; Copyright (C) 1991-2021 Free Software Foundation, Inc.
+;; Copyright (C) 1991-2022 Free Software Foundation, Inc.
;; See the "HY-COPY" file for license information.
;;
;; This file is part of GNU Hyperbole.
@@ -69,9 +69,10 @@ Use (setq set (set:remove elt set)) to assure set is always
properly modified."
;; ************************************************************************
(defun set:combinations (set &optional arity)
- "Return all possible combinations (subsets) of SET including the empty set
and the SET itself.
-Assume SET is a valid set. With optional ARITY, return only subsets with
-ARITY members."
+ "Return all possible combinations (subsets) of SET.
+This includes the empty set and the SET itself. Assume SET is a
+valid set. With optional ARITY, return only subsets with ARITY
+members."
(cond ((null arity)
(setq arity 0)
(cons nil (apply 'nconc (mapcar (lambda (_elt) (setq arity (1+ arity))
(set:combinations set arity))
diff --git a/test/demo-tests.el b/test/demo-tests.el
index e21228b1e3..5c8d87219b 100644
--- a/test/demo-tests.el
+++ b/test/demo-tests.el
@@ -578,7 +578,7 @@ enough files with matching mode loaded."
(existing-shell-flag (get-buffer-process shell-buffer-name)))
(unwind-protect
(with-temp-buffer
- (insert "{M-x shell RET M-> (time apropos grep) RET RET}")
+ (insert "{M-x shell RET M-> (apropos grep) RET RET}")
(goto-char 5)
(action-key)
(hy-test-helpers:consume-input-events)
| [Prev in Thread] |
Current Thread |
[Next in Thread] |
- [elpa] externals/hyperbole b789bfa004 2/2: Merge branch 'master' of hyperbole,
ELPA Syncer <=