[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[elpa] externals/hyperbole 8f1f770 04/21: Apply some easy to fix flychec
|
From: |
Stefan Monnier |
|
Subject: |
[elpa] externals/hyperbole 8f1f770 04/21: Apply some easy to fix flycheck suggestions |
|
Date: |
Fri, 4 Oct 2019 14:58:23 -0400 (EDT) |
branch: externals/hyperbole
commit 8f1f770ac7e1571e973b9aa49e83e6a6eda06165
Author: Mats Lidell <address@hidden>
Commit: Mats Lidell <address@hidden>
Apply some easy to fix flycheck suggestions
Use "? " at end of y-or-n-p
Remove "." at end of error messages
Use imperative voice in docs strings
This fixes the bulk of flycheck messages. There are things left to
correct but they will require more work and that will have to be dealt
with later.
---
hact.el | 61 ++++++++++-----------
hactypes.el | 76 +++++++++++++-------------
hargs.el | 53 ++++++++++---------
hbdata.el | 62 +++++++++++-----------
hbmap.el | 14 ++---
hbut.el | 122 +++++++++++++++++++++---------------------
hgnus.el | 8 +--
hhist.el | 8 +--
hib-debbugs.el | 16 +++---
hib-doc-id.el | 12 ++---
hib-kbd.el | 26 ++++-----
hib-social.el | 16 +++---
hibtypes.el | 10 ++--
hinit.el | 12 ++---
hload-path.el | 2 +-
hmail.el | 30 +++++------
hmh.el | 12 ++---
hmoccur.el | 18 +++----
hmouse-drv.el | 12 ++---
hmouse-info.el | 18 +++----
hmouse-key.el | 12 ++---
hmouse-mod.el | 14 ++---
hmouse-sh.el | 8 +--
hmouse-tag.el | 50 ++++++++---------
hpath.el | 84 ++++++++++++++---------------
hrmail.el | 14 ++---
hsettings.el | 6 +--
hsmail.el | 6 +--
hsys-org.el | 36 ++++++-------
hsys-www.el | 2 +-
htz.el | 10 ++--
hui-em-but.el | 8 +--
hui-jmenu.el | 6 +--
hui-menu.el | 4 +-
hui-mini.el | 14 ++---
hui-mouse.el | 156 +++++++++++++++++++++++++++---------------------------
hui-select.el | 42 +++++++--------
hui-treemacs.el | 3 +-
hui-window.el | 96 ++++++++++++++++-----------------
hui.el | 102 +++++++++++++++++------------------
hvar.el | 20 +++----
hversion.el | 6 +--
hvm.el | 24 ++++-----
hycontrol.el | 24 ++++-----
hypb.el | 60 ++++++++++-----------
hyperbole.el | 22 ++++----
hyrolo-demo.el | 3 ++
hyrolo-logic.el | 4 +-
hyrolo.el | 54 +++++++++----------
hywconfig.el | 26 ++++-----
kotl/kcell.el | 4 +-
kotl/kexport.el | 2 +-
kotl/kfile.el | 32 +++++------
kotl/kfill.el | 10 ++--
kotl/kimport.el | 20 +++----
kotl/klabel.el | 20 +++----
kotl/klink.el | 4 +-
kotl/knode.el | 14 ++---
kotl/kotl-mode.el | 32 +++++------
kotl/kprop-xe.el | 2 +-
kotl/kview.el | 42 +++++++--------
kotl/kvspec.el | 10 ++--
62 files changed, 852 insertions(+), 844 deletions(-)
diff --git a/hact.el b/hact.el
index e765732..e3d8998 100644
--- a/hact.el
+++ b/hact.el
@@ -36,8 +36,8 @@ e.g. to inhibit actions.")
;;; ========================================================================
(defun symset:add (elt symbol prop)
- "Adds ELT to SYMBOL's PROP set.
-Returns nil iff ELT is already in SET. Uses `eq' for comparison."
+ "Add ELT to SYMBOL's PROP set.
+Return nil iff ELT is already in SET. Uses `eq' for comparison."
(let* ((set (get symbol prop))
(set:equal-op 'eq)
(new-set (set:add elt set)))
@@ -46,11 +46,11 @@ Returns nil iff ELT is already in SET. Uses `eq' for
comparison."
(defalias 'symset:delete 'symset:remove)
(defun symset:get (symbol prop)
- "Returns SYMBOL's PROP set."
+ "Return SYMBOL's PROP set."
(get symbol prop))
(defun symset:remove (elt symbol prop)
- "Removes ELT from SYMBOL's PROP set and returns the new set.
+ "Remove ELT from SYMBOL's PROP set and return the new set.
Assumes PROP is a valid set. Uses `eq' for comparison."
(let ((set (get symbol prop))
(set:equal-op 'eq))
@@ -61,11 +61,11 @@ Assumes PROP is a valid set. Uses `eq' for comparison."
;;; ========================================================================
(defun htype:body (htype-sym)
- "Returns body for HTYPE-SYM. If HTYPE-SYM is nil, returns nil."
+ "Return body for HTYPE-SYM. If HTYPE-SYM is nil, return nil."
(and htype-sym (hypb:indirect-function htype-sym)))
(defun htype:category (type-category)
- "Returns list of symbols in Hyperbole TYPE-CATEGORY in priority order.
+ "Return list of symbols in Hyperbole TYPE-CATEGORY in priority order.
Symbols contain category component.
TYPE-CATEGORY should be 'actypes, 'ibtypes or nil for all."
(let ((types (symset:get type-category 'symbols))
@@ -76,7 +76,7 @@ TYPE-CATEGORY should be 'actypes, 'ibtypes or nil for all."
;; Thanks to JWZ for help on this.
(defmacro htype:create (type type-category doc params body property-list)
- "Creates a new Hyperbole TYPE within TYPE-CATEGORY (both unquoted symbols).
+ "Create a new Hyperbole TYPE within TYPE-CATEGORY (both unquoted symbols).
Third arg DOC is a string describing the type.
Fourth arg PARAMS is a list of parameters to send to the fifth arg BODY,
which is a list of forms executed when the type is evaluated.
@@ -93,8 +93,8 @@ Returns the new function symbol derived from TYPE."
',sym)))
(defun htype:delete (type type-category)
- "Deletes a Hyperbole TYPE derived from TYPE-CATEGORY (both symbols).
-Returns the Hyperbole symbol for the TYPE if it existed, else nil."
+ "Delete a Hyperbole TYPE derived from TYPE-CATEGORY (both symbols).
+Return the Hyperbole symbol for the TYPE if it existed, else nil."
(let* ((sym (htype:symbol type type-category))
(exists (fboundp 'sym)))
(setplist sym nil)
@@ -104,11 +104,11 @@ Returns the Hyperbole symbol for the TYPE if it existed,
else nil."
(and exists sym)))
(defun htype:doc (type)
- "Returns documentation for Hyperbole TYPE, a symbol."
+ "Return documentation for Hyperbole TYPE, a symbol."
(documentation type))
(defun htype:names (type-category &optional sym)
- "Returns a list of the current names for Hyperbole TYPE-CATEGORY in priority
order.
+ "Return a list of the current names for TYPE-CATEGORY in priority order.
Names do not contain the category component.
TYPE-CATEGORY should be 'actypes, 'ibtypes or nil for all.
When optional SYM is given, returns the name for that symbol only, if any."
@@ -124,7 +124,7 @@ When optional SYM is given, returns the name for that
symbol only, if any."
;;; ------------------------------------------------------------------------
(defun htype:symbol (type type-category)
- "Returns Hyperbole type symbol composed from TYPE and TYPE-CATEGORY (both
symbols)."
+ "Return Hyperbole type symbol composed from TYPE and TYPE-CATEGORY (both
symbols)."
(intern (concat (symbol-name type-category) "::"
(symbol-name type))))
@@ -133,7 +133,7 @@ When optional SYM is given, returns the name for that
symbol only, if any."
;;; ========================================================================
(defun action:commandp (function)
- "Returns interactive calling form if FUNCTION has one, else nil."
+ "Return interactive calling form if FUNCTION has one, else nil."
(let ((action
(cond ((null function) nil)
((symbolp function)
@@ -153,13 +153,13 @@ When optional SYM is given, returns the name for that
symbol only, if any."
(t (commandp action)))))
(defun action:create (param-list body)
- "Creates Hyperbole action defined by PARAM-LIST and BODY, a list of Lisp
forms."
+ "Create Hyperbole action defined by PARAM-LIST and BODY, a list of Lisp
forms."
(if (symbolp body)
body
(list 'function (cons 'lambda (cons param-list body)))))
(defun action:kbd-macro (macro &optional repeat-count)
- "Returns Hyperbole action that executes a keyboard MACRO REPEAT-COUNT times."
+ "Return Hyperbole action that execute a keyboard MACRO REPEAT-COUNT times."
(list 'execute-kbd-macro macro repeat-count))
;; This function is based on Emacs `help-function-arglist'.
@@ -216,7 +216,7 @@ When optional SYM is given, returns the name for that
symbol only, if any."
(action:params-emacs def)))))
(defun action:params (action)
- "Returns unmodified ACTION parameter list.
+ "Return unmodified ACTION parameter list.
Autoloads action function if need be to get the parameter list."
(when (and (symbolp action) (fboundp action))
(setq action (hypb:indirect-function action)))
@@ -233,21 +233,21 @@ Autoloads action function if need be to get the parameter
list."
(car (cdr (and (fboundp action) (hypb:indirect-function action)))))))
(defun action:param-list (action)
- "Returns list of actual ACTION parameters (removes `&' special forms)."
+ "Return list of actual ACTION parameters (remove `&' special forms)."
(delq nil (mapcar (lambda (param)
(if (eq (aref (symbol-name param) 0) ?&)
nil param))
(action:params action))))
(defun action:path-args-abs (args-list &optional default-dirs)
- "Returns any paths in ARGS-LIST made absolute.
+ "Return any paths in ARGS-LIST made absolute.
Uses optional DEFAULT-DIRS or `default-directory'.
Other arguments are returned unchanged."
(mapcar (lambda (arg) (hpath:absolute-to arg default-dirs))
args-list))
(defun action:path-args-rel (args-list)
- "Returns any paths in ARGS-LIST below current directory made relative.
+ "Return any paths in ARGS-LIST below current directory made relative.
Other paths are simply expanded. Non-path arguments are returned unchanged."
(let ((dir (hattr:get 'hbut:current 'dir)))
(mapcar (lambda (arg) (hpath:relative-to arg dir))
@@ -259,14 +259,15 @@ Other paths are simply expanded. Non-path arguments are
returned unchanged."
;;; ========================================================================
(defmacro hact (&rest args)
- "Performs action formed from rest of ARGS and returns the result or acts as
a no-op when testing implicit button type contexts.
+ "Perform action formed from rest of ARGS and return the result.
+Alternatively act as a no-op when testing implicit button type contexts.
First arg may be a symbol or symbol name for either an action type or a
function. Runs `action-act-hook' before performing action.
The value of `hrule:action' determines what effect this has."
(eval `(cons 'funcall (cons 'hrule:action ',args))))
(defun actype:act (actype &rest args)
- "Performs action formed from ACTYPE and rest of ARGS and returns value.
+ "Perform action formed from ACTYPE and rest of ARGS and return value.
If value is nil, however, t is returned instead, to ensure that implicit button
types register the performance of the action. ACTYPE may be a symbol or symbol
name for either an action type or a function. Runs `action-act-hook' before
@@ -299,7 +300,7 @@ performing ACTION."
))))
(defun actype:action (actype)
- "Returns action part of ACTYPE (a symbol or symbol name).
+ "Return action part of ACTYPE (a symbol or symbol name).
ACTYPE may be a Hyperbole actype or Emacs Lisp function."
(let (actname)
(if (stringp actype)
@@ -313,7 +314,7 @@ ACTYPE may be a Hyperbole actype or Emacs Lisp function."
)))
(defmacro actype:create (type params doc &rest default-action)
- "Creates an action TYPE (an unquoted symbol) with PARAMS, described by DOC.
+ "Create an action TYPE (an unquoted symbol) with PARAMS, described by DOC.
The type uses PARAMS to perform DEFAULT-ACTION (list of the rest of the
arguments). A call to this function is syntactically the same as for
`defun', but a doc string is required.
@@ -324,11 +325,11 @@ Returns symbol created when successful, else nil."
(put 'actype:create 'lisp-indent-function 'defun)
(defun actype:delete (type)
- "Deletes an action TYPE (a symbol). Returns TYPE's symbol if it existed."
+ "Delete an action TYPE (a symbol). Return TYPE's symbol if it existed."
(htype:delete type 'actypes))
(defun actype:doc (hbut &optional full)
- "Returns first line of act doc for HBUT (a Hyperbole button symbol).
+ "Return first line of act doc for HBUT (a Hyperbole button symbol).
With optional FULL, returns full documentation string.
Returns nil when no documentation."
(let* ((act (and (hbut:is-p hbut) (or (hattr:get hbut 'action)
@@ -350,25 +351,25 @@ Returns nil when no documentation."
doc))
(defun actype:identity (&rest args)
- "Returns list of ARGS unchanged or if no ARGS, returns t.
+ "Return list of ARGS unchanged or if no ARGS, return t.
Used as the setting of `hrule:action' to inhibit action evaluation."
(or args t))
(defun actype:interact (actype)
- "Interactively calls default action for ACTYPE.
+ "Interactively call default action for ACTYPE.
ACTYPE is a symbol that was previously defined with `defact'.
Returns nil only when no action is found or the action has no interactive
-calling form."
+calling form."
(let ((action (htype:body
(intern-soft (concat "actypes::" (symbol-name actype))))))
(and action (action:commandp action) (or (call-interactively action) t))))
(defun actype:params (actype)
- "Returns list of ACTYPE's parameters, including keywords."
+ "Return list of ACTYPE's parameters, including keywords."
(action:params (actype:action actype)))
(defun actype:param-list (actype)
- "Returns list of ACTYPE's parameters without keywords."
+ "Return list of ACTYPE's parameters without keywords."
(action:param-list (actype:action actype)))
(provide 'hact)
diff --git a/hactypes.el b/hactypes.el
index c0b6f82..1cd2f07 100644
--- a/hactypes.el
+++ b/hactypes.el
@@ -69,7 +69,7 @@ error."
(cond ((fboundp macro))
((null last-kbd-macro)
(hypb:error
- "(exec-kbd-macro): Define a keyboard macro first."))
+ "(exec-kbd-macro): Define a keyboard macro first"))
(t (defalias '$%macro last-kbd-macro)
(setq macro '$%macro)))
(save-excursion
@@ -111,9 +111,9 @@ kill the last output to the shell buffer before executing
SHELL-CMD."
(list (hargs:read "Shell cmd: "
(lambda (cmd) (not (string-equal cmd "")))
default "Enter a shell command." 'string)
- (y-or-n-p (format "Omit cmd from output (default = %s): "
+ (y-or-n-p (format "Omit cmd from output (default = %s)? "
default1))
- (y-or-n-p (format "Kill prior cmd's output (default = %s): "
+ (y-or-n-p (format "Kill prior cmd's output (default = %s)? "
default2)))))
(require 'comint)
(let ((buf-name "*Hyperbole Shell*")
@@ -180,7 +180,7 @@ kill the last output to the shell buffer before executing
SHELL-CMD."
(message msg)))
(defact function-in-buffer (name pos)
- "Displays the definition of function NAME found at POS in the current
buffer."
+ "Display the definition of function NAME found at POS in the current buffer."
(save-excursion
(goto-char pos)
(unless (looking-at (regexp-quote name))
@@ -194,11 +194,11 @@ kill the last output to the shell buffer before executing
SHELL-CMD."
(beginning-of-line)))
(defact hyp-config (&optional out-buf)
- "Inserts Hyperbole configuration information at the end of the current
buffer or within optional OUT-BUF."
+ "Insert Hyperbole configuration information at the end of the current buffer
or within optional OUT-BUF."
(hypb:configuration out-buf))
(defact hyp-request (&optional out-buf)
- "Inserts into optional OUT-BUF a description of how to subscribe or
unsubscribe from a Hyperbole mail list via email."
+ "Insert into optional OUT-BUF a description of how to subscribe or
unsubscribe from a Hyperbole mail list via email."
(save-excursion
(and out-buf (set-buffer out-buf))
;; Allows for insertion prior to user's email signature
@@ -218,7 +218,7 @@ where possible <list-names> are:
For example: To: address@hidden\n")))
(defact hyp-source (buf-str-or-file)
- "Displays a buffer or file from a line beginning with `hbut:source-prefix'."
+ "Display a buffer or file from a line beginning with `hbut:source-prefix'."
(interactive
(list (prin1-to-string (get-buffer-create
(read-buffer "Buffer to link to: "))
@@ -231,7 +231,7 @@ For example: To: address@hidden\n")))
(hypb:error "(hyp-source): Non-string argument: %s" buf-str-or-file)))
(defact link-to-buffer-tmp (buffer &optional point)
- "Displays a BUFFER scrolled to optional POINT.
+ "Display a BUFFER scrolled to optional POINT.
If POINT is given, the buffer is displayed with POINT at the top of
the window.
@@ -246,12 +246,12 @@ Use `link-to-file' instead for a permanent link."
(hypb:error "(link-to-buffer-tmp): Not a current buffer: %s" buffer)))
(defact link-to-directory (directory)
- "Displays a DIRECTORY in Dired mode."
+ "Display a DIRECTORY in Dired mode."
(interactive "DDirectory to link to: ")
(hpath:find directory))
(defact link-to-ebut (key &optional key-file)
- "Performs action given by an explicit button, specified by KEY and optional
KEY-FILE.
+ "Perform action given by an explicit button, specified by KEY and optional
KEY-FILE.
KEY-FILE defaults to the current buffer's file name."
(interactive
(let (but-file but-lbl)
@@ -281,23 +281,23 @@ KEY-FILE defaults to the current buffer's file name."
(let ((but (and key-file (ebut:get key (find-file-noselect key-file)))))
(if but
(hbut:act but)
- (hypb:error "(link-to-ebut): No button `%s' in `%s'."
+ (hypb:error "(link-to-ebut): No button `%s' in `%s'"
(ebut:key-to-label key)
key-file))))
(defact link-to-elisp-doc (symbol)
- "Displays documentation for SYMBOL."
+ "Display documentation for SYMBOL."
(interactive "SSymbol to display documentation for: ")
(cond ((not (symbolp symbol))
- (hypb:error "(link-to-elisp-doc): `%s' not a symbol." symbol))
+ (hypb:error "(link-to-elisp-doc): `%s' not a symbol" symbol))
((not (or (boundp symbol) (fboundp symbol)))
- (hypb:error "(link-to-elisp-doc): `%s' not defined." symbol))
+ (hypb:error "(link-to-elisp-doc): `%s' not defined" symbol))
(t (let ((temp-buffer-show-function 'switch-to-buffer))
(hpath:display-buffer (current-buffer))
(describe-symbol symbol)))))
(defact link-to-file (path &optional point)
- "Displays a file given by PATH scrolled to optional POINT.
+ "Display a file given by PATH scrolled to optional POINT.
If POINT is given, the buffer is displayed with POINT at the top of
the window."
(interactive
@@ -321,7 +321,7 @@ the window."
(with-current-buffer path-buf
(setq hargs:reading-p 'character)
(if (y-or-n-p
- (format "y = Display at present position (line %d); n =
no position: "
+ (format "y = Display at present position (line %d); n =
no position? "
(count-lines 1 (point))))
(list path (point))
(list path)))
@@ -335,7 +335,7 @@ the window."
(recenter 0))))
(defact link-to-file-line (path line-num)
- "Displays a file given by PATH scrolled to LINE-NUM."
+ "Display a file given by PATH scrolled to LINE-NUM."
(interactive "fPath to link to: \nnDisplay at line number: ")
(if (condition-case ()
(setq path (smart-tags-file-path path))
@@ -346,7 +346,7 @@ the window."
(hpath:find-line path line-num))))
(defact link-to-file-line-and-column (path line-num column-num)
- "Displays a file given by PATH scrolled to LINE-NUM with point at
COLUMN-NUM."
+ "Display a file given by PATH scrolled to LINE-NUM with point at COLUMN-NUM."
(interactive "fPath to link to: \nnDisplay at line number: \nnand column
number: ")
(when (condition-case ()
(setq path (smart-tags-file-path path))
@@ -358,12 +358,12 @@ the window."
(move-to-column column-num)))
(defact link-to-gbut (key)
- "Performs an action given by an existing global button, specified by KEY."
+ "Perform an action given by an existing global button, specified by KEY."
(interactive
(let ((gbut-file (hpath:validate (hpath:substitute-value gbut:file)))
but-lbl)
(if (not (file-readable-p gbut-file))
- (hypb:error "(link-to-gbut): You cannot read `%s'." gbut-file)
+ (hypb:error "(link-to-gbut): You cannot read `%s'" gbut-file)
(list (progn
(find-file-noselect gbut-file)
(while (string-equal "" (setq but-lbl
@@ -376,7 +376,7 @@ the window."
(gbut:act (hbut:key-to-label key)))
(defact link-to-Info-index-item (index-item)
- "Displays an Info index INDEX-ITEM cross-reference.
+ "Display an Info index INDEX-ITEM cross-reference.
INDEX-ITEM must be a string of the form \"(filename)item-name\". During
button creation, completion for both filename and item-name is
available. Filename may be given without the .info suffix."
@@ -387,7 +387,7 @@ available. Filename may be given without the .info suffix."
(hypb:error "(link-to-Info-index-entry): Invalid Info index item: `%s'"
index-item)))
(defact link-to-Info-node (string)
- "Displays an Info node given by STRING or if not found, trys to display it
as an Info index item.
+ "Display an Info node given by STRING or if not found, try to display it as
an Info index item.
STRING must be a string of the form \"(filename)name\". During
button creation, completion for both filename and node names is
available. Filename may be given without the .info suffix."
@@ -398,7 +398,7 @@ available. Filename may be given without the .info suffix."
(hypb:error "(link-to-Info-node): Invalid Info node: `%s'" string)))
(defact link-to-ibut (key &optional key-file point)
- "Performs an action given by an implicit button, specified by KEY, optional
KEY-FILE and POINT.
+ "Perform an action given by an implicit button, specified by KEY, optional
KEY-FILE and POINT.
KEY-FILE defaults to the current buffer's file and POINT to the current point.
When creating the button, point must be on the implicit button to which to link
@@ -425,12 +425,12 @@ and its buffer must have a file attached."
(setq but (ibut:to key))))
(if but
(hbut:act but)
- (hypb:error "(link-to-ibut): No button `%s' in `%s'."
+ (hypb:error "(link-to-ibut): No button `%s' in `%s'"
(ibut:key-to-label key)
(or key-file (buffer-name))))))
(defact link-to-kcell (file cell-ref)
- "Displays FILE with kcell given by CELL-REF at window top.
+ "Display FILE with kcell given by CELL-REF at window top.
See documentation for `kcell:ref-to-id' for valid cell-ref formats.
If FILE is nil, the current buffer is used.
@@ -450,12 +450,12 @@ If CELL-REF is nil, the first cell in the view is shown."
(recenter 0))))
(defact link-to-mail (mail-msg-id &optional mail-file)
- "Displays mail msg with MAIL-MSG-ID from optional MAIL-FILE.
+ "Display mail msg with MAIL-MSG-ID from optional MAIL-FILE.
See documentation for the variable `hmail:init-function' for information on
how to specify a mail reader to use."
(interactive "+MMail Msg: ")
(if (not (fboundp 'rmail:msg-to-p))
- (hypb:error "(link-to-mail): Invoke mail reader before trying to follow
a mail link.")
+ (hypb:error "(link-to-mail): Invoke mail reader before trying to follow
a mail link")
(if (and (listp mail-msg-id) (null mail-file))
(setq mail-file (car (cdr mail-msg-id))
mail-msg-id (car mail-msg-id)))
@@ -470,14 +470,14 @@ how to specify a mail reader to use."
(unless (rmail:msg-to-p mail-msg-id mail-file)
;; Couldn't find message, restore old window config, report error
(set-window-configuration wconfig)
- (hypb:error "(link-to-mail): No msg `%s' in file \"%s\"."
+ (hypb:error "(link-to-mail): No msg `%s' in file \"%s\""
mail-msg-id mail-file)))))
(defact link-to-regexp-match (regexp n source &optional buffer-p)
- "Finds REGEXP's Nth occurrence in SOURCE and displays location at window top.
+ "Find REGEXP's Nth occurrence in SOURCE and display location at window top.
SOURCE is a pathname unless optional BUFFER-P is non-nil, then SOURCE must be
a buffer name or buffer.
-Returns t if found, signals an error if not."
+Return t if found, signal an error if not."
(interactive "sRegexp to match: \nnOccurrence number: \nfFile to search: ")
(let ((orig-src source))
(if buffer-p
@@ -501,23 +501,23 @@ Returns t if found, signals an error if not."
"(link-to-regexp-match): Pattern not found: `%s'" regexp)))))
(defact link-to-rfc (rfc-num)
- "Retrieves and displays an Internet rfc given by RFC-NUM.
+ "Retrieve and display an Internet rfc given by RFC-NUM.
RFC-NUM may be a string or an integer."
(interactive "nRFC number to retrieve: ")
(if (or (stringp rfc-num) (integerp rfc-num))
(hpath:find (hpath:rfc rfc-num))))
(defact link-to-string-match (string n source &optional buffer-p)
- "Finds STRING's Nth occurrence in SOURCE and displays location at window top.
+ "Find STRING's Nth occurrence in SOURCE and display location at window top.
SOURCE is a pathname unless optional BUFFER-P is non-nil, then SOURCE must be
a buffer name or buffer.
-Returns t if found, nil if not."
+Return t if found, nil if not."
(interactive "sString to match: \nnOccurrence number: \nfFile to search: ")
(funcall (actype:action 'link-to-regexp-match)
(regexp-quote string) n source buffer-p))
(defact link-to-texinfo-node (nodename)
- "Displays the Texinfo node with NODENAME (a string) from the current buffer."
+ "Display the Texinfo node with NODENAME (a string) from the current buffer."
(interactive "sTexinfo nodename to link to: ")
(let (node-point)
(save-excursion
@@ -529,7 +529,7 @@ Returns t if found, nil if not."
(hact 'link-to-file buffer-file-name node-point)))
(defact link-to-web-search (service-name search-term)
- "Searches web SERVICE-NAME for SEARCH-TERM.
+ "Search web SERVICE-NAME for SEARCH-TERM.
Uses `hyperbole-web-search-alist' to match each service to its search url.
Uses `hyperbole-web-search-browser-function' and the `browse-url'
package to display search results."
@@ -537,7 +537,7 @@ package to display search results."
(hyperbole-web-search service-name search-term))
(defact man-show (topic)
- "Displays man page on TOPIC, which may be of the form <command>(<section>).
+ "Display man page on TOPIC, which may be of the form <command>(<section>).
Uses `hpath:display-where' setting to control where the man page is displayed."
(interactive "sManual topic: ")
(require 'man)
@@ -545,7 +545,7 @@ Uses `hpath:display-where' setting to control where the man
page is displayed."
(hpath:display-buffer (man topic))))
(defact rfc-toc (&optional buf-name opoint)
- "Computes and displays summary of an Internet rfc in BUF-NAME.
+ "Compute and display summary of an Internet rfc in BUF-NAME.
Assumes point has already been moved to start of region to summarize.
Optional OPOINT is point to return to in BUF-NAME after displaying summary."
(interactive)
@@ -574,7 +574,7 @@ Optional OPOINT is point to return to in BUF-NAME after
displaying summary."
(if opoint (goto-char opoint))))
(defact text-toc (section)
- "Jumps to the text file SECTION referenced by a table of contents entry at
point."
+ "Jump to the text file SECTION referenced by a table of contents entry at
point."
(interactive "sGo to section named: ")
(if (stringp section)
(progn
diff --git a/hargs.el b/hargs.el
index c4610bb..09fd98f 100644
--- a/hargs.el
+++ b/hargs.el
@@ -34,7 +34,7 @@
;;; ************************************************************************
(defvar hargs:reading-p nil
- "t only when Hyperbole is prompting user for input, else nil.")
+ "Is t only when Hyperbole is prompting user for input, else nil.")
(add-hook 'completion-setup-hook #'hargs:set-string-to-complete)
(add-hook 'minibuffer-exit-hook #'hargs:unset-string-to-complete)
@@ -80,9 +80,9 @@
(defun hargs:action-get (action modifying)
- "Interactively gets list of arguments for ACTION's parameters.
+ "Interactively get list of arguments for ACTION's parameters.
Current button is being modified when MODIFYING is non-nil.
-Returns nil if ACTION is not a list or byte-code object, has no
+Return nil if ACTION is not a list or `byte-code' object, has no
interactive form or takes no arguments."
(and (or (hypb:emacs-byte-code-p action) (listp action))
(let ((interactive-form (action:commandp action)))
@@ -101,7 +101,7 @@ interactive form or takes no arguments."
(defun hargs:delimited (start-delim end-delim
&optional start-regexp-flag end-regexp-flag
list-positions-flag exclude-regexp)
- "Returns a normalized, single line, delimited string that point is within
the first line of, or nil.
+ "Return a normalized, single line, delimited string that point is within the
first line of, or nil.
START-DELIM and END-DELIM are strings that specify the argument
delimiters. With optional START-REGEXP-FLAG non-nil, START-DELIM is
treated as a regular expression. END-REGEXP-FLAG is similar.
@@ -167,7 +167,7 @@ With optional EXCLUDE-REGEXP, any matched string is ignored
if it this regexp."
string))))))))
(defun hargs:get (interactive-entry &optional default prior-arg)
- "Prompts for an argument, if need be, from INTERACTIVE-ENTRY, a string.
+ "Prompt for an argument, if need be, from INTERACTIVE-ENTRY, a string.
Optional DEFAULT is inserted after prompt.
First character of INTERACTIVE-ENTRY must be a command character from
the list in the documentation for `interactive' or a `+' which
@@ -178,7 +178,7 @@ May return a single value or a list of values, in which
case the first
element of the list is always the symbol 'args."
(let (func cmd prompt)
(cond ((or (null interactive-entry) (equal interactive-entry ""))
- (error "(hargs:get): Empty interactive-entry arg."))
+ (error "(hargs:get): Empty interactive-entry arg"))
;; Hyperbole / user extension command character. The next
;; character is the actual command character.
((eq (aref interactive-entry 0) ?+)
@@ -189,7 +189,7 @@ element of the list is always the symbol 'args."
(if func
(funcall func prompt default)
(error
- "(hargs:get): Bad interactive-entry extension character: `%c'."
+ "(hargs:get): Bad interactive-entry extension character: `%c'"
cmd)))
;; Normal interactive command character
(t (setq cmd (aref interactive-entry 0)
@@ -200,11 +200,11 @@ element of the list is always the symbol 'args."
(if func
(funcall func prompt default)
(error
- "(hargs:get): Bad interactive-entry command character: `%c'."
+ "(hargs:get): Bad interactive-entry command character: `%c'"
cmd))))))
(defun hargs:make-iform-vector (iform-alist)
- "Returns a vector built from IFORM-ALIST used for looking up interactive
command code characters."
+ "Return a vector built from IFORM-ALIST used for looking up interactive
command code characters."
;; Vector needs to have 1 more elts than the highest char code for
;; interactive commands.
(let* ((size (1+ (car (sort (mapcar 'car iform-alist) '>))))
@@ -218,7 +218,7 @@ element of the list is always the symbol 'args."
vec))
(defun hargs:prompt (prompt default &optional default-prompt)
- "Returns string of PROMPT including DEFAULT.
+ "Return string of PROMPT including DEFAULT.
Optional DEFAULT-PROMPT is used to describe default value."
(if default
(format "%s(%s%s%s) " prompt (or default-prompt "default")
@@ -249,7 +249,7 @@ Optional DEFAULT-PROMPT is used to describe default value."
(setq hargs:string-to-complete nil))
(defun hargs:sexpression-p (&optional no-recurse)
- "Returns an sexpression at point as a string.
+ "Return an sexpression at point as a string.
If point follows an sexpression end character, the preceding sexpression
is returned. If point precedes an sexpression start character, the
following sexpression is returned. Otherwise, the innermost sexpression
@@ -278,12 +278,12 @@ that point is within is returned or nil if none."
;;; ************************************************************************
(defun hargs:actype-get (actype &optional modifying)
- "Interactively gets and returns list of arguments for ACTYPE's parameters.
+ "Interactively gets and return list of arguments for ACTYPE's parameters.
Current button is being modified when MODIFYING is non-nil."
(hargs:action-get (actype:action actype) modifying))
(defun hargs:at-p (&optional no-default)
- "Returns thing at point, if of hargs:reading-p type, or default.
+ "Return thing at point, if of hargs:reading-p type, or default.
If optional argument NO-DEFAULT is non-nil, nil is returned instead of any
default values.
@@ -386,7 +386,7 @@ Handles all of the interactive argument types that
`hargs:iform-read' does."
(t Info-current-node))))
(cond ((and (stringp node) (string-match "\\`\(" node))
node)
- (file
+ (file
(concat "(" file ")" node))
(t node)))))
((eq hargs:reading-p 'mail)
@@ -409,7 +409,8 @@ Handles all of the interactive argument types that
`hargs:iform-read' does."
(read (current-buffer)))))))
(defun hargs:completion (&optional no-insert)
- "If in the completions buffer, return completion at point. Also insert
unless optional NO-INSERT is non-nil.
+ "If in the completions buffer, return completion at point.
+Also insert unless optional NO-INSERT is non-nil.
Insert in minibuffer if active or in other window if minibuffer is inactive."
(interactive '(nil))
(if (or (string-match "[* ]Completions\\*\\'" (buffer-name))
@@ -476,7 +477,7 @@ Insert in minibuffer if active or in other window if
minibuffer is inactive."
entry)))))
(defun hargs:iform-read (iform &optional modifying)
- "Reads action arguments according to IFORM, a list with car = 'interactive.
+ "Read action arguments according to IFORM, a list with car = 'interactive.
Optional MODIFYING non-nil indicates current button is being modified, so
button's current values should be presented as defaults. Otherwise, uses
hargs:defaults as list of defaults, if any.
@@ -487,7 +488,7 @@ See also documentation for `interactive'."
(setq prefix-arg current-prefix-arg)
(if (not (and (listp iform) (eq (car iform) 'interactive)))
(error
- "(hargs:iform-read): arg must be a list whose car = 'interactive.")
+ "(hargs:iform-read): arg must be a list whose car = 'interactive")
(setq iform (car (cdr iform)))
(if (or (null iform) (and (stringp iform) (equal iform "")))
nil
@@ -528,7 +529,7 @@ See also documentation for `interactive'."
;; `_' means keep region in same state (active or inactive)
;; after this command. (XEmacs only.)
;;
- (while (cond
+ (while (cond
((eq (aref iform i) ?*))
((eq (aref iform i) ?@)
(hargs:select-event-window)
@@ -561,7 +562,7 @@ See also documentation for `interactive'."
(setq hargs:reading-p prev-reading-p))))))
(defun hargs:read (prompt &optional predicate default err val-type)
- "PROMPTs without completion for a value matching PREDICATE and returns it.
+ "PROMPT without completion for a value matching PREDICATE and return it.
PREDICATE is an optional boolean function of one argument. Optional DEFAULT
is a string to insert after PROMPT as the default return value. Optional
ERR is a string to display temporarily when an invalid value is given.
@@ -588,7 +589,7 @@ string read or nil."
t
(and stringify
;; Remove any double quoting of strings.
- (string-match "\\`\"\\([^\"]*\\)\"\\'" val)
+ (string-match "\\`\"\\([^\"]*\\)\"\\'" val)
(setq val (match-string 1 val)))
(and predicate (not (funcall predicate val)))))
(if bad-val (setq bad-val nil) (setq default val))
@@ -602,9 +603,9 @@ string read or nil."
(defun hargs:read-match (prompt collection
&optional predicate must-match initial-input val-type)
- "PROMPTs with completion for a value in COLLECTION and returns it.
+ "PROMPT with completion for a value in COLLECTION and return it.
COLLECTION may be a list of strings, an alist, an obarray (for
-symbol-name completion) or a hash collection. COLLECTION may also be
+`symbol-name' completion) or a hash collection. COLLECTION may also be
a function to do the completion itself. Optional PREDICATE
limits completion to a subset of COLLECTION. Optional MUST-MATCH
means value returned must be from COLLECTION. Optional INITIAL-INPUT
@@ -628,7 +629,7 @@ VAL-TYPE is a symbol indicating the type of value to be
read."
(switch-to-buffer obuf)))))
(defun hargs:select-p (&optional value assist-flag)
- "Returns optional VALUE or value selected at point if any, else nil.
+ "Return optional VALUE or value selected at point if any, else nil.
If value is the same as the contents of the minibuffer, it is used as
the current minibuffer argument, otherwise, the minibuffer is erased
and value is inserted there.
@@ -732,7 +733,7 @@ help when appropriate."
(if prefix-arg
(prefix-numeric-value prefix-arg)
(let ((arg))
- (while (not (integerp
+ (while (not (integerp
(setq arg (read-minibuffer prompt default))))
(beep))
arg))))
@@ -780,7 +781,7 @@ help when appropriate."
(setq hargs:iforms-extensions
'(
;; Get existing Info node name, possibly prefixed with its (filename).
- (?I . (Info-node .
+ (?I . (Info-node .
(let ((prev-reading-p hargs:reading-p))
(unwind-protect
(progn (require 'info)
@@ -820,7 +821,7 @@ help when appropriate."
;; Get a Koutline viewspec.
(?V . (kvspec . (hargs:read prompt nil nil nil 'kvspec)))
;; Get existing Info index item name, possibly prefixed with its
(filename).
- (?X . (Info-index-item .
+ (?X . (Info-index-item .
(let ((prev-reading-p hargs:reading-p))
(unwind-protect
(let (file item)
diff --git a/hbdata.el b/hbdata.el
index 022c37c..2716e4b 100644
--- a/hbdata.el
+++ b/hbdata.el
@@ -59,58 +59,58 @@
;;; Button data accessor functions
;;; ------------------------------------------------------------------------
(defun hbdata:action (hbdata)
- "[Hyp V2] Returns action overriding button's action type or nil."
+ "[Hyp V2] Return action overriding button's action type or nil."
(nth 1 hbdata))
(defun hbdata:actype (hbdata)
- "Returns the action type in HBDATA as a string."
+ "Return the action type in HBDATA as a string."
(let ((nm (symbol-name (nth 3 hbdata))))
(and nm (if (or (= (length nm) 2) (string-match "::" nm))
nm (concat "actypes::" nm)))))
(defun hbdata:args (hbdata)
- "Returns the list of any arguments given in HBDATA."
+ "Return the list of any arguments given in HBDATA."
(nth 4 hbdata))
(defun hbdata:categ (hbdata)
- "Returns the category of HBDATA's button."
+ "Return the category of HBDATA's button."
'explicit)
(defun hbdata:creator (hbdata)
- "Returns the user-id of the original creator of HBDATA's button."
+ "Return the user-id of the original creator of HBDATA's button."
(nth 5 hbdata))
(defun hbdata:create-time (hbdata)
- "Returns the original creation time given for HBDATA's button."
+ "Return the original creation time given for HBDATA's button."
(nth 6 hbdata))
(defun hbdata:key (hbdata)
- "Returns the indexing key in HBDATA as a string."
+ "Return the indexing key in HBDATA as a string."
(car hbdata))
(defun hbdata:loc-p (hbdata)
- "[Hyp V1] Returns 'L iff HBDATA referent is within a local file system.
+ "[Hyp V1] Return 'L iff HBDATA referent is within a local file system.
Returns 'R if remote and nil if irrelevant for button action type."
(nth 1 hbdata))
(defun hbdata:modifier (hbdata)
- "Returns the user-id of the most recent modifier of HBDATA's button.
+ "Return the user-id of the most recent modifier of HBDATA's button.
Nil is returned when button has not been modified."
(nth 7 hbdata))
(defun hbdata:mod-time (hbdata)
- "Returns the time of the most recent change to HBDATA's button.
+ "Return the time of the most recent change to HBDATA's button.
Nil is returned when button has not beened modified."
(nth 8 hbdata))
(defun hbdata:referent (hbdata)
- "Returns the referent name in HBDATA."
+ "Return the referent name in HBDATA."
(nth 2 hbdata))
(defun hbdata:search (buf label partial)
- "Go to Hyperbole hbdata BUF and find LABEL whole or PARTIAL matches.
- Search is case-insensitive. Returns list with elements:
- (<button-src> <label-key1> ... <label-keyN>)."
+ "Go to Hyperbole hbdata BUF and find LABEL whole or PARTIAL match.
+Search is case-insensitive. Return list with elements:
+\(<button-src> <label-key1> ... <label-keyN>)."
(set-buffer buf)
(let ((case-fold-search t) (src-matches) (src) (matches) (end))
(goto-char (point-min))
@@ -135,11 +135,11 @@ Nil is returned when button has not beened modified."
;;; ------------------------------------------------------------------------
(defun hbdata:build (&optional mod-lbl-key but-sym)
- "Constructs button data from optional MOD-LBL-KEY and BUT-SYM; modifies
BUT-SYM attributes.
+ "Construct button data from optional MOD-LBL-KEY and BUT-SYM; modifies
BUT-SYM attributes.
MOD-LBL-KEY nil means create a new entry, otherwise modify existing one.
Nil BUT-SYM means use 'hbut:current'. If successful, returns a cons of
(button-data . button-instance-str), else nil."
- (let* ((but)
+ (let* ((but)
(b (hattr:copy (or but-sym 'hbut:current) 'but))
(l (hattr:get b 'loc))
(key (or mod-lbl-key (hattr:get b 'lbl-key)))
@@ -169,7 +169,7 @@ Nil BUT-SYM means use 'hbut:current'. If successful,
returns a cons of
(if (hbdata:to-entry-buf loc dir) (forward-line 1))))
(let ((inst-num (hbdata:instance-last new-key loc dir)))
(setq lbl-instance (if inst-num
- (hbdata:instance-next
+ (hbdata:instance-next
(concat new-key ebut:instance-sep
(int-to-string inst-num))))))))
(when (or entry (not mod-lbl-key))
@@ -206,7 +206,7 @@ Nil BUT-SYM means use 'hbut:current'. If successful,
returns a cons of
(cons hbdata lbl-instance))))))
(defun hbdata:get-entry (lbl-key key-src &optional directory)
- "Returns button data entry given by LBL-KEY, KEY-SRC and optional DIRECTORY.
+ "Return button data entry given by LBL-KEY, KEY-SRC and optional DIRECTORY.
Returns nil if no matching entry is found.
A button data entry is a list of attribute values. Use methods from
class 'hbdata' to operate on the entry."
@@ -215,7 +215,7 @@ class 'hbdata' to operate on the entry."
lbl-key key-src directory))
(defun hbdata:instance-next (lbl-key)
- "Returns string for button instance number following LBL-KEY's.
+ "Return string for button instance number following LBL-KEY's.
Nil if LBL-KEY is nil."
(and lbl-key
(if (string-match
@@ -227,11 +227,11 @@ Nil if LBL-KEY is nil."
":2")))
(defun hbdata:instance-last (lbl-key key-src &optional directory)
- "Returns highest instance number for repeated button label.
+ "Return highest instance number for repeated button label.
1 if not repeated, nil if no instance.
Takes arguments LBL-KEY, KEY-SRC and optional DIRECTORY."
(hbdata:apply-entry
- (lambda ()
+ (lambda ()
(if (looking-at "[0-9]+")
(string-to-number (match-string 0))
1))
@@ -270,7 +270,7 @@ Use methods from class 'hbdata' to operate on the entry."
(delete-region (point) (progn (forward-line 1) (point))))
(defun hbdata:to-entry (but-key key-src &optional directory instance)
- "Returns button data entry indexed by BUT-KEY, KEY-SRC, optional DIRECTORY.
+ "Return button data entry indexed by BUT-KEY, KEY-SRC, optional DIRECTORY.
Returns nil if entry is not found. Leaves point at start of entry when
successful or where entry should be inserted if unsuccessful.
A button entry is a list. Use methods from class 'hbdata' to operate on the
@@ -295,7 +295,7 @@ but-key."
(defun hbdata:apply-entry (function lbl-key key-src &optional directory
create instance)
- "Invokes FUNCTION with point at hbdata entry given by LBL-KEY, KEY-SRC,
optional DIRECTORY.
+ "Invoke FUNCTION with point at hbdata entry given by LBL-KEY, KEY-SRC,
optional DIRECTORY.
With optional CREATE, if no such line exists, inserts a new file entry at the
beginning of the hbdata file (which is created if necessary).
INSTANCE non-nil means search for any button instance matching LBL-KEY and
@@ -349,7 +349,7 @@ Returns value of evaluation when a matching entry is found
or nil."
rtn))
(defun hbdata:to-hbdata-buffer (dir &optional create)
- "Reads in the file containing DIR's button data, if any, and returns buffer.
+ "Read in the file containing DIR's button data, if any, and return buffer.
If it does not exist and optional CREATE is non-nil, creates a new
one and returns buffer, otherwise returns nil."
(let* ((file (expand-file-name hattr:filename (or dir default-directory)))
@@ -361,11 +361,11 @@ one and returns buffer, otherwise returns nil."
(progn (set-buffer buf)
(or (verify-visited-file-modtime (get-file-buffer file))
(cond ((yes-or-no-p
- "Hyperbole button data file has changed, read new
contents? ")
+ "Hyperbole button data file has changed, read new
contents? ")
(revert-buffer t t)
)))
(or (= (point-max) 1) (eq (char-after 1) ?\^L)
- (error "File %s is not a valid Hyperbole button data table."
file))
+ (error "File %s is not a valid Hyperbole button data table"
file))
(or (equal (buffer-name) file) (rename-buffer file))
(setq buffer-read-only nil)
(or existing-file (hbmap:dir-add (file-name-directory file)))
@@ -373,9 +373,9 @@ one and returns buffer, otherwise returns nil."
(defun hbdata:to-entry-buf (key-src &optional directory create)
- "Moves point to end of line in but data buffer matching KEY-SRC.
+ "Move point to end of line in but data buffer matching KEY-SRC.
Uses hbdata file in KEY-SRC's directory, or optional DIRECTORY or if nil, uses
-default-directory.
+`default-directory'.
With optional CREATE, if no such line exists, inserts a new file entry at the
beginning of the hbdata file (which is created if necessary).
Returns non-nil if KEY-SRC is found or created, else nil."
@@ -411,11 +411,11 @@ Returns non-nil if KEY-SRC is found or created, else nil."
rtn))
(defun hbdata:write (&optional orig-lbl-key but-sym)
- "Tries to write Hyperbole button data from optional ORIG-LBL-KEY and BUT-SYM.
+ "Try to write Hyperbole button data from optional ORIG-LBL-KEY and BUT-SYM.
ORIG-LBL-KEY nil means create a new entry, otherwise modify existing one.
-BUT-SYM nil means use 'hbut:current'. If successful, returns
+BUT-SYM nil means use 'hbut:current'. If successful, return
a button instance string to append to button label or t when first instance.
-On failure, returns nil."
+On failure, return nil."
(let ((cons (hbdata:build orig-lbl-key but-sym))
entry lbl-instance)
(if (or (and buffer-file-name
diff --git a/hbmap.el b/hbmap.el
index baf0273..5db1a30 100644
--- a/hbmap.el
+++ b/hbmap.el
@@ -24,7 +24,7 @@
;;; ************************************************************************
(defun hbmap:dir-add (dir-name &optional no-save)
- "Adds DIR-NAME to map of all directories in which user has written buttons.
+ "Add DIR-NAME to map of all directories in which user has written buttons.
Returns t iff DIR-NAME is not already in map, nil if it is, and some
other value when cannot read or write map.
Optional NO-SAVE disables saving of the map after an add."
@@ -34,7 +34,7 @@ Optional NO-SAVE disables saving of the map after an add."
no-save))
(defun hbmap:dir-list ()
- "Returns list of all directories in which user has written buttons."
+ "Return list of all directories in which user has written buttons."
(save-excursion
(let ((buf (if (and (file-exists-p hbmap:dir-filename)
(not (file-readable-p hbmap:dir-filename)))
@@ -51,7 +51,7 @@ Optional NO-SAVE disables saving of the map after an add."
dirs)))))
(defun hbmap:dir-remove (dir-name &optional no-save)
- "Removes DIR-NAME from map of all dirs in which user has written buttons.
+ "Remove DIR-NAME from map of all dirs in which user has written buttons.
Returns t iff DIR-NAME is in the map and is successfully removed, nil if it
is not, and some other value when the map is not readable or writable.
Optional NO-SAVE disables saving of the map after a removal."
@@ -60,7 +60,7 @@ Optional NO-SAVE disables saving of the map after a removal."
no-save))
(defun hbmap:dir-member (dir-name)
- "Returns t iff DIR-NAME is a member of user's Hyperbole map, else nil.
+ "Return t iff DIR-NAME is a member of user's Hyperbole map, else nil.
If t, point is left at the start of the matching map entry. If nil,
point is left in a position appropriate for insertion of a new entry."
(let ((obuf (current-buffer))
@@ -80,9 +80,9 @@ point is left in a position appropriate for insertion of a
new entry."
;;; ************************************************************************
(defun hbmap:dir-operate (pred dir-name form &optional no-save)
- "If PRED called on DIR-NAME is non-nil, evaluates FORM.
-Returns t if PRED evaluation is successful and nil when not, except when
-hbmap is not readable or writable, in which case returns a symbol indicating
+ "If PRED called on DIR-NAME is non-nil, evaluate FORM.
+Return t if PRED evaluation is successful and nil when not, except when
+hbmap is not readable or writable, in which case return a symbol indicating
the error. Optional NO-SAVE disables saving of the map after operation."
(save-excursion
(let ((buf (if (and (file-exists-p hbmap:dir-filename)
diff --git a/hbut.el b/hbut.el
index cb4816b..d672c5a 100644
--- a/hbut.el
+++ b/hbut.el
@@ -45,13 +45,13 @@ Nil disables saving.")
(error "(ebut:act): No explicit button labeled: %s" label))))
(defun ebut:alist (&optional file)
- "Returns alist of ebuts in FILE or the current buffer.
+ "Return alist of ebuts in FILE or the current buffer.
Each element is a list of just an explicit button label. For use
as a completion table."
(mapcar 'list (ebut:list file)))
(defun ebut:at-p (&optional start-delim end-delim)
- "Returns explicit Hyperbole button at point or nil.
+ "Return explicit Hyperbole button at point or nil.
Assumes point is within first line of button label, if at all.
Optional START-DELIM and END-DELIM are strings that override default
button delimiters."
@@ -60,9 +60,9 @@ button delimiters."
(ebut:get key))))
(defun ebut:create (&optional but-sym)
- "Creates Hyperbole explicit button based on optional BUT-SYM.
+ "Create Hyperbole explicit button based on optional BUT-SYM.
Default is `hbut:current'.
-Button should hold the following attributes (see `hattr:set'):
+Button should hold the following attributes (see `hattr:set'):
lbl-key (normalized button label string),
loc (filename or buffer where button is located),
dir (directory name where button is located),
@@ -87,14 +87,14 @@ Default is `hbut:current'.
Returns entry deleted (a list of attribute values) or nil."
(if (null but-sym) (setq but-sym 'hbut:current))
(if (ebut:is-p but-sym)
- (let* ((but-key (hattr:get but-sym 'lbl-key))
+ (let* ((but-key (hattr:get but-sym 'lbl-key))
(loc (hattr:get but-sym 'loc))
(entry (hbdata:delete-entry but-key loc)))
(run-hooks 'ebut-delete-hook)
entry)))
(defun ebut:get (&optional lbl-key buffer key-src)
- "Returns explicit Hyperbole button symbol given by LBL-KEY and BUFFER.
+ "Return explicit Hyperbole button symbol given by LBL-KEY and BUFFER.
KEY-SRC is given when retrieving global buttons and is the full source
pathname.
Retrieves button data, converts into a button object and returns a symbol
@@ -149,12 +149,12 @@ buffer."
'hbut:current)))))
(defun ebut:is-p (object)
- "Returns non-nil if OBJECT denotes an explicit Hyperbole button."
+ "Return non-nil if OBJECT denotes an explicit Hyperbole button."
(and (symbolp object)
(eq (hattr:get object 'categ) 'explicit)))
(defun ebut:key-of-label-p (key label)
- "Returns t iff KEY matches to LABEL in a case insensitive manner."
+ "Return t iff KEY matches to LABEL in a case insensitive manner."
(and (stringp key) (stringp label)
(equal key (downcase (ebut:label-to-key label)))))
@@ -164,7 +164,7 @@ buffer."
(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)
- "Returns key for the Hyperbole explicit button label that point is within,
else nil.
+ "Return key for the Hyperbole explicit button label that point is within,
else nil.
Assumes point is within the first line of any button label. All
following arguments are optional. If AS-LABEL is non-nil, label
is returned rather than the key derived from the label.
@@ -224,8 +224,8 @@ label search to two lines."
(defalias 'ebut:label-to-key 'hbut:label-to-key)
(defun ebut:list (&optional file loc-p)
- "Returns list of button labels from in FILE or the current buffer.
-Removes duplicate labels if optional LOC-P is omitted. With LOC-P, returns
+ "Return list of button labels from in FILE or the current buffer.
+Remove duplicate labels if optional LOC-P is omitted. With LOC-P, return
list of elements (label start end) where start and end are the buffer
positions at which the button delimiter begins and ends."
(interactive)
@@ -246,7 +246,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)
- "Applies 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 the current
buffer.
If REGEXP-MATCH is non-nil, only buttons which match this argument are
considered.
@@ -270,7 +270,7 @@ If successful, leaves point in button data buffer, so
caller should use
lbl-instance)))
(defun ebut:next-occurrence (lbl-key &optional buffer)
- "Moves point to next occurrence of button with LBL-KEY in optional BUFFER.
+ "Move point to next occurrence of button with LBL-KEY in optional BUFFER.
BUFFER defaults to current buffer. It may be a buffer name.
Returns non-nil iff occurrence is found.
@@ -285,7 +285,7 @@ move to the first occurrence of the button."
(goto-char (+ (match-beginning 0) (length ebut:start)))))
(defun ebut:operate (curr-label new-label)
- "Operates on and modifies properties of a new or existing explicit button
given by CURR-LABEL.
+ "Operate on and modify properties of a new or existing 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.
Returns instance string appended to label to form a per-buffer unique
@@ -425,7 +425,7 @@ enables partial matches."
(with-current-buffer out-buf
(if firstmatch
(progn
- (insert hbut:source-prefix "\""
+ (insert hbut:source-prefix "\""
currfile "\"\n")
(setq firstmatch nil)))
(insert tag lns))))
@@ -487,7 +487,7 @@ Inserts INSTANCE-STR after END, before ending delimiter."
t))
(defun ebut:match-regexp (match-keys match-part)
- "Returns regexp to match to all explicit button keys from MATCH-KEYS."
+ "Return regexp to match to all explicit button keys from MATCH-KEYS."
(setq match-part (if match-part
(concat "[^" (substring ebut:end -1) "]*")
"[ \t\n\r]*"))
@@ -527,7 +527,7 @@ Inserts INSTANCE-STR after END, before ending delimiter."
(error "(gbut:act): No global button found for label: %s"
label))))))
(defun gbut:get (&optional lbl-key)
- "Returns global Hyperbole button symbol given by optional LBL-KEY if found
in gbut:file.
+ "Return global Hyperbole button symbol given by optional LBL-KEY if found in
gbut:file.
Retrieves any button data, converts into a button object and returns a symbol
which references the button.
@@ -549,7 +549,7 @@ the button that point is within or nil."
(error "(gbut:help): No global button labeled: %s" label))))
(defun gbut:label-list ()
- "Returns list of global button labels."
+ "Return list of global button labels."
(mapcar 'hbut:key-to-label (gbut:key-list)))
@@ -571,11 +571,11 @@ Returns the symbol for the button, else nil."
;;; ------------------------------------------------------------------------
(defun gbut:key-list ()
- "Returns list of global button label keys."
+ "Return list of global button label keys."
(nconc (gbut:ebut-key-list) (gbut:ibut-key-list)))
(defun gbut:ebut-key-list ()
- "Returns a list of explicit button label keys from the global button file."
+ "Return a list of explicit button label keys from the global button file."
(save-excursion
(if (hbdata:to-entry-buf gbut:file)
(let (gbuts)
@@ -589,7 +589,7 @@ Returns the symbol for the button, else nil."
gbuts)))))
(defun gbut:ibut-key-list ()
- "Returns a list of implicit button label keys from the global button file."
+ "Return a list of implicit button label keys from the global button file."
(when (file-readable-p gbut:file)
(save-excursion
(set-buffer (find-file-noselect gbut:file))
@@ -602,7 +602,7 @@ Returns the symbol for the button, else nil."
;;; ========================================================================
(defun hattr:attributes (obj-symbol)
- "Returns a list of OBJ-SYMBOL's attributes as symbols."
+ "Return a list of OBJ-SYMBOL's attributes as symbols."
(if (symbolp obj-symbol)
(let* ((attr-val-list (symbol-plist obj-symbol))
(i -1))
@@ -612,7 +612,7 @@ Returns the symbol for the button, else nil."
attr-val-list)))))
(defun hattr:clear (hbut)
- "Removes all of HBUT's attributes except `variable-documentation'."
+ "Remove all of HBUT's attributes except `variable-documentation'."
(let (sublist)
(or (symbolp hbut)
(error "(hattr:clear): Argument not a Hyperbole button: %s" hbut))
@@ -635,18 +635,18 @@ Returns TO-HBUT."
to-hbut)
(defun hattr:get (obj-symbol attr-symbol)
- "Returns value of OBJ-SYMBOL's attribute ATTR-SYMBOL."
+ "Return value of OBJ-SYMBOL's attribute ATTR-SYMBOL."
(get obj-symbol attr-symbol))
(defun hattr:list (obj-symbol)
- "Returns a property list of OBJ-SYMBOL's attributes.
+ "Return a property list of OBJ-SYMBOL's attributes.
Each pair of elements is: <attrib-name> <attrib-value>."
(if (symbolp obj-symbol)
(symbol-plist obj-symbol)
(error "(hattr:list): Argument not a symbol: %s" obj-symbol)))
(defun hattr:memq (attr-symbol obj-symbol)
- "Returns t if ATTR-SYMBOL is in OBJ-SYMBOL's attribute list, else nil."
+ "Return t if ATTR-SYMBOL is in OBJ-SYMBOL's attribute list, else nil."
(and (symbolp obj-symbol) (symbolp attr-symbol)
(let* ((attr-val-list (symbol-plist obj-symbol))
(attr-list (let ((i -1))
@@ -658,7 +658,7 @@ Each pair of elements is: <attrib-name> <attrib-value>."
(if (memq attr-symbol attr-list) t))))
(defun hattr:report (attrib-list)
- "Pretty prints to standard-output attribute-value pairs from ATTRIB-LIST.
+ "Pretty print to `standard-output' attribute-value pairs from ATTRIB-LIST.
Ignores nil valued attributes. Returns t unless no attributes are printed."
(let ((has-attr) attr val len)
(unless (or (null attrib-list) (not (listp attrib-list))
@@ -686,14 +686,14 @@ Ignores nil valued attributes. Returns t unless no
attributes are printed."
has-attr)))
(defun hattr:save ()
- "Saves button attribute file for current directory, if modified.
+ "Save button attribute file for current directory, if modified.
Suitable for use as part of `write-file-functions'."
(let* ((bd-file (expand-file-name hattr:filename default-directory))
(buf (and (stringp default-directory)
(get-file-buffer bd-file))))
(if (and ebut:hattr-save buf (not (eq buf (current-buffer))))
(let ((ebut:hattr-save));; Prevents `write-file-functions' from looping.
- (and (buffer-modified-p buf)
+ (and (buffer-modified-p buf)
(with-current-buffer buf (save-buffer)
;; Unlock button attribute file; kill buffer so user is
;; never holding a buffer which is out of sync with file,
@@ -705,7 +705,7 @@ Suitable for use as part of `write-file-functions'."
nil)
(defun hattr:set (obj-symbol attr-symbol attr-value)
- "Sets OBJ-SYMBOL's attribute ATTR-SYMBOL to ATTR-VALUE and returns
ATR-VALUE."
+ "Set OBJ-SYMBOL's attribute ATTR-SYMBOL to ATTR-VALUE and return ATR-VALUE."
(put obj-symbol attr-symbol attr-value))
(defalias 'hattr:summarize 'hattr:report)
@@ -721,12 +721,12 @@ others who use a different value!")
;;; ========================================================================
(defun hbut:act (hbut)
- "Performs action for explicit or implicit Hyperbole button symbol HBUT."
+ "Perform action for explicit or implicit Hyperbole button symbol HBUT."
(if hbut (apply 'actype:act (hattr:get hbut 'actype)
(hattr:get hbut 'args))))
(defun hbut:action (hbut)
- "Returns appropriate action for Hyperbole button symbol HBUT."
+ "Return appropriate action for Hyperbole button symbol HBUT."
(let ((categ (hattr:get hbut 'categ)) (atype) (action))
(if (eq categ 'explicit)
(progn (setq action (hattr:get hbut 'action)
@@ -738,12 +738,12 @@ others who use a different value!")
(if (fboundp atype) atype))))
(defun hbut:at-p ()
- "Returns symbol for explicit or implicit Hyperbole button at point or nil."
+ "Return symbol for explicit or implicit Hyperbole button at point or nil."
(or (ebut:at-p) (ibut:at-p)))
(defun hbut:comment (start end)
- "Comments button label spanning region START to END in current buffer.
+ "Comment button label spanning region START to END in current buffer.
Usees buffer commenting grammar, if any, otherwise doesn't comment.
Ignores email-related buffers."
(save-excursion
@@ -805,7 +805,7 @@ Ignores email-related buffers."
"List of regexps of fill prefixes to remove from the middle of buttons.")
(defun hbut:fill-prefix-remove (label)
- "Removes any recognized fill prefix from within LABEL.
+ "Remove any recognized fill prefix from within LABEL.
`hbut:fill-prefix-regexps' is a list of fill prefixes to recognize."
(if (string-match "\n" label)
(mapc (lambda (fill-prefix)
@@ -827,11 +827,11 @@ nil. BUFFER defaults to the current buffer."
(or (ebut:get lbl-key buffer key-src) (ibut:get lbl-key buffer key-src)))
(defun hbut:is-p (object)
- "Returns non-nil if object denotes a Hyperbole button."
+ "Return non-nil if OBJECT denotes a Hyperbole button."
(and (symbolp object) (hattr:get object 'categ)))
(defun hbut:key-src (&optional full)
- "Returns key source (usually unqualified) for current Hyperbole button.
+ "Return key source (usually unqualified) for current Hyperbole button.
Also sets current buffer to key source.
With optional FULL when source is a pathname, the full pathname is returned."
(let ((src (cond ((hmail:mode-is-p) (current-buffer))
@@ -926,14 +926,14 @@ represent the output of particular document formatters."
lbl)))
(defun hbut:label (hbut)
- "Returns the label for Hyperbole button symbol HBUT."
+ "Return the label for Hyperbole button symbol HBUT."
(if (hbut:is-p hbut)
(hbut:key-to-label (hattr:get hbut 'lbl-key))
(error "(hbut:label): Argument is not a Hyperbole button symbol, `%s'"
hbut)))
(defun hbut:label-p (&optional as-label start-delim end-delim pos-flag
two-lines-flag)
- "Returns key for the Hyperbole button label that point is within, else nil.
+ "Return key for the Hyperbole button label that point is within, else nil.
Assumes point is within the first line of any button label. All
following arguments are optional. If AS-LABEL is non-nil, label
is returned rather than the key derived from the label.
@@ -946,7 +946,7 @@ label search to two lines."
(ibut:label-p as-label start-delim end-delim pos-flag two-lines-flag)))
(defun hbut:label-regexp (lbl-key &optional no-delim start-delim end-delim)
- "Unnormalizes LBL-KEY. Returns regular expr matching delimited button label.
+ "Unnormalize LBL-KEY. Return regular expr matching delimited button label.
Optional NO-DELIM leaves off delimiters and leading and trailing space.
Optional START-DELIM and END-DELIM are added around the returned
label; these default to `ebut:start' and `ebut:end'."
@@ -960,7 +960,7 @@ label; these default to `ebut:start' and `ebut:end'."
(case-fold-search))
(while (< pos len)
(setq c (aref lbl-key pos)
- regexp (concat regexp
+ regexp (concat regexp
(if (eq c ?_)
(if (or (= (1+ pos) len)
(not (eq (aref lbl-key (1+ pos)) ?_)))
@@ -1032,14 +1032,14 @@ include delimiters when INCLUDE-DELIMS is non-nil)."
(nreverse rtn)))
(defun hbut:outside-comment-p ()
- "Returns t if within a programming language buffer and prior regexp match is
outside a comment, else nil."
+ "Return t if within a programming language buffer and prior regexp match is
outside a comment, else nil."
(when (and (derived-mode-p 'prog-mode)
(not (eq major-mode 'lisp-interaction-mode)))
;; Match is outside of a programming language comment
(not (nth 4 (syntax-ppss)))))
(defun hbut:report (&optional arg)
- "Pretty prints the attributes of a button or buttons.
+ "Pretty print the attributes of a button or buttons.
Takes an optional ARG interpreted as follows:
a button symbol - report on that button;
@@ -1047,7 +1047,7 @@ Takes an optional ARG interpreted as follows:
integer > 0 - report on all explicit buttons in buffer, alphabetize;
integer < 1 - report on all explicit buttons in occurrence order.
-Returns number of buttons reported on or nil if none."
+Return number of buttons reported on or nil if none."
(setq arg (cond ((or (integerp arg) (symbolp arg)) arg)
((listp arg)
(if (integerp (setq arg (car arg))) arg 1))
@@ -1106,7 +1106,7 @@ Returns number of buttons reported on or nil if none."
(length lbl-lst)))))
(defun hbut:source (&optional full)
- "Returns Hyperbole source buffer or file given at point.
+ "Return Hyperbole source buffer or file given at point.
If a file, always returns a full path if optional FULL is non-nil."
(goto-char (match-end 0))
(cond ((looking-at "#<buffer \"?\\([^\n\"]+\\)\"?>")
@@ -1127,21 +1127,21 @@ If a file, always returns a full path if optional FULL
is non-nil."
(defconst hbut:source-prefix moccur-source-prefix
"String found at start of a buffer containing only a hyper-button menu.
- This expression should be followed immediately by a file-name indicating the
+This expression should be followed immediately by a file-name indicating the
source file for the buttons in the menu, if any.")
(defun hbut:label-list ()
- "Returns list of current buffer's Hyperbole button labels."
+ "Return list of current buffer's Hyperbole button labels."
(mapcar 'hbut:key-to-label (hbut:key-list)))
;;; ------------------------------------------------------------------------
(defun hbut:key-list ()
- "Returns list of global button label keys."
+ "Return list of global button label keys."
(nconc (hbut:ebut-key-list) (hbut:ibut-key-list)))
(defun hbut:ebut-key-list (&optional key-src)
- "Returns a list of explicit button label keys from optional KEY-SRC or the
current buffer."
+ "Return a list of explicit button label keys from optional KEY-SRC or the
current buffer."
(save-excursion
(if (hbdata:to-entry-buf (or key-src (buffer-file-name)))
(let (hbuts)
@@ -1155,7 +1155,7 @@ source file for the buttons in the menu, if any.")
hbuts)))))
(defun hbut:ibut-key-list (&optional key-src)
- "Returns a list of implicit button label keys from optional KEY-SRC or the
current buffer."
+ "Return a list of implicit button label keys from optional KEY-SRC or the
current buffer."
(save-excursion
(when (hbut:key-src-set-buffer (or key-src (current-buffer)))
(save-restriction
@@ -1173,7 +1173,7 @@ as a completion table."
(mapcar 'list (ibut:list file)))
(defun ibut:at-p (&optional key-only)
- "Returns symbol for implicit button at point, else nil.
+ "Return symbol for implicit button at point, else nil.
Point may be on the implicit button or its optional preceding label.
With optional KEY-ONLY, returns only the label key for button.
@@ -1232,7 +1232,7 @@ excluding delimiters, not just one."
(goto-char opoint))))
(defun ibut:at-type-p (ibut-type-symbol)
- "Returns non-nil if point is on a button of type `ibut-type-symbol`.
+ "Return non-nil if point is on a button of type IBUT-TYPE-SYMBOL.
Point must be on the button itself and not its label, if any.
The return value is a list of the type's action type symbol and
@@ -1248,7 +1248,7 @@ associated arguments from the button."
(funcall ibut-type-symbol))))))
(defun ibut:get (&optional lbl-key buffer key-src)
- "Returns implicit Hyperbole button symbol given by LBL-KEY and BUFFER.
+ "Return implicit Hyperbole button symbol given by LBL-KEY and BUFFER.
KEY-SRC is given when retrieving global buttons and is the full source
pathname.
Returns a symbol which references the button.
@@ -1283,19 +1283,19 @@ nil. BUFFER defaults to the current buffer."
(ibut:at-p)))))
(defun ibut:is-p (object)
- "Returns non-nil if object denotes an implicit Hyperbole button."
+ "Return non-nil if OBJECT denotes an implicit Hyperbole button."
(if (symbolp object)
(let ((categ (hattr:get object 'categ)))
(and categ (string-match "^ibtypes::" (symbol-name categ))))))
(defun ibut:label-map (but-func &optional start-delim end-delim
regexp-match include-delims)
- "Applies BUT-FUNC to buttons delimited by optional START-DELIM and END-DELIM.
+ "Apply BUT-FUNC to buttons delimited by optional START-DELIM and END-DELIM.
START-DELIM defaults to ibut:label-start; END-DELIM defaults to ibut:label-end.
If REGEXP-MATCH is non-nil, only buttons which match this argument are
considered.
-Maps over portion of buffer visible under any current restriction.
+Map over portion of buffer visible under any current restriction.
BUT-FUNC must take precisely three arguments: the button label, the
start position of the delimited button label and its end position (positions
include delimiters when INCLUDE-DELIMS is non-nil).
@@ -1321,7 +1321,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)
- "Returns key for the Hyperbole implicit button label that point is within,
else nil.
+ "Return key for the Hyperbole implicit button label that point is within,
else nil.
This is an optional label that may precede an implicit button.
Use `ibut:at-p' instead to test if point is on either the
implicit button itself or the label. Assumes point is within the
@@ -1338,12 +1338,12 @@ constrains 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)
- "Unnormalizes ibutton LBL-KEY. Returns regular expr matching delimited
button label.
+ "Unnormalize ibutton LBL-KEY. Return regular expr matching delimited button
label.
Optional NO-DELIM leaves off delimiters and 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)
- "Sets current implicit button attributes from LABEL and optional START, END
positions.
+ "Set current implicit button attributes from LABEL and optional START, END
positions.
Returns 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
@@ -1396,7 +1396,7 @@ 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)
- "Moves point to next occurrence of a labeled implicit button with LBL-KEY in
optional BUFFER.
+ "Move point to next occurrence of a labeled implicit button with LBL-KEY in
optional BUFFER.
BUFFER defaults to current buffer. It may be a buffer name.
Returns non-nil iff occurrence is found.
@@ -1457,7 +1457,7 @@ Returns the symbol for the button, else nil."
(defalias 'defib 'ibtype:create)
(put 'ibtype:create 'lisp-indent-function 'defun)
(defmacro ibtype:create (type params doc at-p &optional to-p style)
- "Creates Hyperbole implicit button TYPE (unquoted sym) with PARAMS,
described by DOC.
+ "Create Hyperbole implicit button TYPE (unquoted sym) with PARAMS, described
by DOC.
PARAMS are presently ignored.
AT-P is a boolean form of no arguments which determines whether or not point
diff --git a/hgnus.el b/hgnus.el
index 42ad426..fd0e4ad 100644
--- a/hgnus.el
+++ b/hgnus.el
@@ -49,16 +49,16 @@
;;;###autoload
(defun Gnus-init ()
- "Initializes Hyperbole support for Gnus Usenet news reading."
+ "Initialize Hyperbole support for Gnus Usenet news reading."
(interactive)
nil)
(defun lnews:to ()
- "Sets current buffer to the Usenet news article summary listing buffer."
+ "Set current buffer to the Usenet news article summary listing buffer."
(and (eq major-mode hnews:reader) (set-buffer gnus-summary-buffer)))
(defun rnews:to ()
- "Sets current buffer to the Usenet news article reader buffer."
+ "Set current buffer to the Usenet news article reader buffer."
(and (eq major-mode hnews:lister) (set-buffer gnus-article-buffer)))
(defun rnews:summ-msg-to ()
@@ -85,7 +85,7 @@
Insert the message being replied to in the reply buffer. Puts point
before the mail headers and mark after body of the text. Calls
mail-yank-original to actually yank the message into the buffer and
-cite text.
+cite text.
If mail-yank-original is not overloaded by supercite, each nonblank
line is indented ARG spaces (default 3). Just \\[universal-argument]
diff --git a/hhist.el b/hhist.el
index 3f988e3..e405925 100644
--- a/hhist.el
+++ b/hhist.el
@@ -24,7 +24,7 @@
;;; ************************************************************************
(defun hhist:add (elt)
- "Adds ELT to hyper-history list if not the same as current or previous loc.
+ "Add ELT to hyper-history list if not the same as current or previous loc.
ELT must have been created via a call to 'hhist:element'."
;; Even though this next line looks useless, it cures a problem with
;; window buffer correspondences on startup, so don't remove it.
@@ -36,11 +36,11 @@ ELT must have been created via a call to 'hhist:element'."
(setq *hhist* (cons elt *hhist*)))))
(defun hhist:element ()
- "Returns a history element for current point location."
+ "Return a history element for current point location."
(current-frame-configuration))
(defun hhist:remove (&optional arg)
- "Removes optional prefix ARG entries from history, returns to ARGth location.
+ "Remove optional prefix ARG entries from history, return to ARGth location.
The command is ignored with ARG < 1."
(interactive "p")
(setq arg (cond ((or (null arg)
@@ -65,7 +65,7 @@ The command is ignored with ARG < 1."
(set-frame-configuration prev-config t)))))
(defun hhist:init ()
- "Resets history list."
+ "Reset history list."
(interactive)
(setq *hhist* nil))
diff --git a/hib-debbugs.el b/hib-debbugs.el
index 49d903c..aee2857 100644
--- a/hib-debbugs.el
+++ b/hib-debbugs.el
@@ -87,7 +87,7 @@
If the query includes a single id number, displays the original message
submission for that id and allows browsing of the followup discussion.
The following buffer text formats are accepted (with point prior to any
-attribute):
+attribute):
bug#id-number or bug# id-number or bug #id-number
bug?attr1=val1&attr2=val2&attr3=val3
@@ -110,7 +110,7 @@ Note that `issue' or `debbugs' may be used as well in place
of `bug'."
(debbugs-gnu-show-discussion)))
(defun debbugs-gnu-query:help (but)
- "Makes a Gnu debbugs id number at point (optionally prefixed with a # sign)
display the pretty pretted status of the bug id.
+ "Make a Gnu debbugs id number at point (optionally prefixed with a # sign)
display the pretty pretted status of the bug id.
Ignores other types of Gnu debbugs query strings."
(if (and (debbugs-version-sufficient-p)
(debbugs-query:at-p)
@@ -125,7 +125,7 @@ Ignores other types of Gnu debbugs query strings."
(hact 'smart-debbugs-gnu)))
(defun debbugs-gnu-mode:help (&optional _but)
- "Makes a Gnu debbugs listing entry at point pretty print the status of the
issue to a window below."
+ "Make a Gnu debbugs listing entry at point pretty print the status of the
issue to a window below."
(condition-case ()
(let ((display-buffer-overriding-action
'(display-buffer-below-selected . nil)))
@@ -146,7 +146,7 @@ Ignores other types of Gnu debbugs query strings."
(call-interactively (key-binding "\C-m")))
(defun debbugs-gnu-query:string (url-query-string)
- "Parses and applies attributes from URL-QUERY-STRING to display the results
of a Gnu debbugs query.
+ "Parse and apply attributes from URL-QUERY-STRING to display the results of
a Gnu debbugs query.
URL-QUERY-STRING must be a valid URL query string (part after the question
mark) of debbugs attributes and values, i.e.
\"attr1=val1&attr2=val2&attr3=val3\"
URL encoded characters are decoded. An optional prefix of \"bug#<id-number>?\"
@@ -166,10 +166,10 @@ issue number. Note that `issue' or `debbugs' may be used
as well in place of `b
(debbugs-gnu-query:list attr-pair-list)))
(defun debbugs-gnu-query:list (query-attribute-list)
- "Applies attributes from QUERY-ATTRIBUTE-LIST to display the results of a
Gnu debbugs query.
+ "Apply attributes from QUERY-ATTRIBUTE-LIST to display the results of a Gnu
debbugs query.
Each element of the list should be of the form (attribute . attribute-value).
Attribute may be a symbol or a string. Common attributes include: status,
-severity, and package."
+severity, and package."
(require 'debbugs-gnu)
(setq debbugs-gnu-current-query nil)
(dolist (attr query-attribute-list)
@@ -194,7 +194,7 @@ severity, and package."
;;; ************************************************************************
(defun debbugs-query:at-p ()
- "Returns t if point appears to be within a debbugs id. Id number is
(match-string 2).
+ "Return t if point appear to be within a debbugs id. Id number is
(match-string 2).
If this is a query with attributes, then (match-string 3) = \"?\" and
(match-string 4) is the query attributes."
;; Point must be before one of the bug#222 characters to match.
(let ((case-fold-search t))
@@ -212,7 +212,7 @@ If this is a query with attributes, then (match-string 3) =
\"?\" and (match-str
)))))
(defun debbugs-query:status (id)
- "Pretty prints to standard-output the status attributes of debbugs ID (a
positive integer).
+ "Pretty print to `standard-output' the status attributes of debbugs ID (a
positive integer).
Ignores nil valued attributes. Returns t unless no attributes are printed."
(require 'debbugs-gnu)
;; The (car (debbugs-get-status id)) is a list of (attribute . value) pairs
which we sort below.
diff --git a/hib-doc-id.el b/hib-doc-id.el
index 5445ad3..8beaf20 100644
--- a/hib-doc-id.el
+++ b/hib-doc-id.el
@@ -117,11 +117,11 @@ signalled."
(let ((hyrolo-display-buffer (hypb:help-buf-name "Doc ID"))
(delim-doc-id (concat doc-id-start doc-id doc-id-end)))
(cond ((null doc-id-indices)
- (error "(doc-id-index-entry): You must set the `doc-id-indices'
variable first."))
+ (error "(doc-id-index-entry): You must set the `doc-id-indices'
variable first"))
((let ((hyrolo-entry-regexp doc-id-index-entry-regexp))
(zerop (hyrolo-grep (funcall doc-id-match doc-id)
1 doc-id-indices nil 'no-display)))
- (error "(doc-id-index-entry): %s not found in document index."
+ (error "(doc-id-index-entry): %s not found in document index"
delim-doc-id))
;; Matching index entry has been put into `hyrolo-display-buffer'.
(t (with-current-buffer hyrolo-display-buffer
@@ -139,7 +139,7 @@ signalled."
(error
"(link-to-doc): %s online location is invalid: \"%s\""
delim-doc-id doc-path))))
- (error "(link-to-doc): %s is unavailable in online form."
+ (error "(link-to-doc): %s is unavailable in online form"
delim-doc-id)))))))
(defib doc-id ()
@@ -167,16 +167,16 @@ delimited by `doc-id-index-entry-regexp'.")
;;; ************************************************************************
(defun doc-id:help (but)
- "Displays site-specific document index entry given by doc-id BUT, in other
window.
+ "Display site-specific document index entry given by doc-id BUT, in other
window.
Also displays standard Hyperbole help for implicit button BUT."
(let ((hyrolo-entry-regexp doc-id-index-entry-regexp)
(hyrolo-display-buffer (hypb:help-buf-name "Doc ID"))
(doc-id (hbut:key-to-label (hattr:get but 'lbl-key))))
(cond ((null doc-id-indices)
- (error "(doc-id-index-entry): You must set the `doc-id-indices'
variable first."))
+ (error "(doc-id-index-entry): You must set the `doc-id-indices'
variable first"))
((zerop (hyrolo-grep (funcall doc-id-match doc-id) 1 doc-id-indices))
(error
- "(doc-id-index-entry): No document index entry found for %s%s%s."
+ "(doc-id-index-entry): No document index entry found for %s%s%s"
doc-id-start doc-id doc-id-end)))
(let* ((report-buf (hypb:help-buf-name))
(temp-buffer-show-hook
diff --git a/hib-kbd.el b/hib-kbd.el
index bc4ab9f..c4b9984 100644
--- a/hib-kbd.el
+++ b/hib-kbd.el
@@ -21,7 +21,7 @@
;; between each key, may contain any number of individual key sequences
;; and the whole thing should be delimited by braces, e.g. {M-x apropos
;; RET hyperbole RET}. Forms such as {\C-b}, {\^b}, and {^b} will not be
-;; recognized.
+;; recognized.
;;; Code:
;;; ************************************************************************
@@ -88,7 +88,7 @@ Any key sequence must be a string of one of the following:
;;; ************************************************************************
(defun kbd-key:act (key-series)
- "Executes the command binding for normalized KEY-SERIES.
+ "Execute the command binding for normalized KEY-SERIES.
Returns t if KEY-SERIES has a binding, else nil."
(interactive "kKeyboard key to execute (no {}): ")
(setq current-prefix-arg nil) ;; Execution of the key-series may set it.
@@ -106,8 +106,8 @@ Returns t if KEY-SERIES has a binding, else nil."
(t (call-interactively binding) t))))
(defun kbd-key:doc (key-series &optional full)
- "Shows first line of doc for binding of keyboard KEY-SERIES in minibuffer.
-With optional prefix arg FULL, displays full documentation for command."
+ "Show first line of doc for binding of keyboard KEY-SERIES in minibuffer.
+With optional prefix arg FULL, display full documentation for command."
(interactive "kKey sequence: \nP")
(let* ((keys (kbd-key:normalize key-series))
(cmd (let ((cmd (key-binding keys)))
@@ -137,7 +137,7 @@ With optional prefix arg FULL, displays full documentation
for command."
(if kbd-key (kbd-key:doc kbd-key t))))
(defun kbd-key:normalize (key-series)
- "Returns KEY-SERIES string (without surrounding {}) normalized into a form
that can be parsed by commands."
+ "Return KEY-SERIES string (without surrounding {}) normalized into a form
that can be parsed by commands."
(interactive "kKeyboard key sequence to normalize (no {}): ")
(if (stringp key-series)
(let ((norm-key-seq (copy-sequence key-series))
@@ -197,11 +197,11 @@ With optional prefix arg FULL, displays full
documentation for command."
;;; ************************************************************************
(defun kbd-key:extended-command-p (key-series)
- "Returns non-nil if the string KEY-SERIES is a normalized extended command
invocation, i.e. M-x command."
+ "Return non-nil if the string KEY-SERIES is a normalized extended command
invocation, i.e. M-x command."
(and (stringp key-series) (string-match kbd-key:extended-command-prefix
key-series)))
(defun kbd-key:hyperbole-hycontrol-key-p (key-series)
- "Returns t if normalized, non-nil KEY-SERIES is given when in a HyControl
mode, else nil.
+ "Return t if normalized, non-nil KEY-SERIES is given when in a HyControl
mode, else nil.
Allows for multiple key sequences strung together."
(and key-series
(featurep 'hycontrol)
@@ -212,13 +212,13 @@ Allows for multiple key sequences strung together."
t))
(defun kbd-key:hyperbole-mini-menu-key-p (key-series)
- "Returns t if normalized KEY-SERIES appears to invoke a Hyperbole menu item
or sequence of keys, else nil."
+ "Return t if normalized KEY-SERIES appears to invoke a Hyperbole menu item
or sequence of keys, else nil."
(when key-series
(let ((mini-menu-key (kbd-key:normalize (key-description (car
(where-is-internal 'hyperbole))))))
(if (string-match (regexp-quote mini-menu-key) key-series) t))))
(defun kbd-key:key-and-arguments (key-series)
- "Returns 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
possibly with following interactive arguments, else nil."
(let ((prefix-binding (and (stringp key-series) (key-binding (substring
key-series 0 1)))))
;; Just ensure that 1st character is bound to something that is
;; not a self-insert-command or a number.
@@ -247,10 +247,10 @@ Allows for multiple key sequences strung together."
string))
(defun kbd-key:special-sequence-p (key-series)
- "Returns non-nil if normalized KEY-SERIES string is one of the following:
- a Hyperbole minibuffer menu item key sequence,
- a HyControl key sequence,
- a M-x extended command,
+ "Return non-nil if normalized KEY-SERIES string is one of the following:
+a Hyperbole minibuffer menu item key sequence,
+a HyControl key sequence,
+a M-x extended command,
or a valid key sequence together with its interactive arguments."
(or (kbd-key:hyperbole-mini-menu-key-p key-series)
(kbd-key:hyperbole-hycontrol-key-p key-series)
diff --git a/hib-social.el b/hib-social.el
index 29df535..1fd3bca 100644
--- a/hib-social.el
+++ b/hib-social.el
@@ -11,7 +11,7 @@
;;; Commentary:
;;
-;; This defines an implicit button type, social-reference, that displays
+;; This defines an implicit button type, social-reference, that displays
;; information (often a web page) associated with the given hashtag or
username.
;; When the referent is a web page, this calls the function given by
;; `hibtypes-social-display-function' to display it, initially set to
`browse-url'.
@@ -343,7 +343,7 @@ or /<project>.
one of the words: branches, commits, contributors, issues, people or staff,
pulls, status or tags; the associated items are listed;
- one of the words: branch, commit, issue, pull or tag followed by a '/' or
'=' and
+ one of the words: branch, commit, issue, pull or tag followed by a '/' or
'=' and
an item-id; the item is shown;
an issue reference given by a positive integer, e.g. 92 or prefaced with
GH-, e.g. GH-92;
@@ -543,7 +543,7 @@ PROJECT value is provided, it defaults to the value of
(setq ref-type "pipeline_schedules"
reference ""))
((string-match "\\`\\(service\\|service_desk\\)\\'"
reference)
- ;; Project help desk
+ ;; Project help desk
(setq ref-type "issues/service_desk"
reference ""))
((member reference '("activity" "branches" "commits"
"issues" "labels"
@@ -607,7 +607,7 @@ PROJECT value is provided, it defaults to the value of
(looking-at "\\s-*commit \\([0-9a-f]+\\)$"))
(hact #'git-reference (match-string-no-properties 1))))
-(defvar hibtypes-git-repos-cache
+(defvar hibtypes-git-repos-cache
(expand-file-name "Local-Git-Repos" hbmap:dir-user)
"Filename of cache of local git repository directories found by
`locate-command'.")
@@ -620,10 +620,10 @@ PROJECT value is provided, it defaults to the value of
(defun hibtypes-git-build-repos-cache (&optional prompt-flag)
"Store cache of local git repo directories in `hibtypes-git-repos-cache'.
-With optional prompt-flag non-nil, prompt user whether to build the cache
before building.
+With optional PROMPT-FLAG non-nil, prompt user whether to build the cache
before building.
Return t if built, nil otherwise."
(when (or (not prompt-flag)
- (y-or-n-p "Find all local git repositories (will take some time)?"))
+ (y-or-n-p "Find all local git repositories (will take some time)?
"))
(message "Please wait while all local git repositories are found...")
(unless (zerop (shell-command (format "%s -r '/\.git$' | sed -e
's+/.git$++' > %s"
(hibtypes-git-get-locate-command)
@@ -651,7 +651,7 @@ Return the project directory found or nil if none."
(defun hibtypes-git-build-or-add-to-repos-cache (project &optional prompt-flag)
"Store cache of local git repo directories in `hibtypes-git-repos-cache'.
-With optional prompt-flag non-nil, prompt user whether to build the cache
before building.
+With optional PROMPT-FLAG non-nil, prompt user whether to build the cache
before building.
Return t if built, nil otherwise."
(if (and (file-readable-p hibtypes-git-repos-cache)
;; Non-zero file size
@@ -867,3 +867,5 @@ is found."
(provide 'hib-social)
+;;; hib-social.el ends here
+
diff --git a/hibtypes.el b/hibtypes.el
index 4c02513..db47b5b 100644
--- a/hibtypes.el
+++ b/hibtypes.el
@@ -51,7 +51,7 @@
"uy" "uz" "va" "vc" "ve" "vg" "vi" "vn" "vu" "wf" "ws" "ye" "yt"
"yu"
"za" "zm" "zw")
t))
- "Regular expression of most common Internet top-level domain names.")
+ "Regular expression of most common Internet top level domain names.")
(defconst mail-address-regexp
"\\([_a-zA-Z][-_a-zA-Z0-9.!@+%]*@[-_a-zA-Z0-9.!@+%]+\\.[a-zA-Z0-9][-_a-zA-Z0-9]+\\)\\($\\|[^a-zA-Z0-9@%]\\)"
@@ -290,8 +290,8 @@ must have an attached file."
;;; ========================================================================
(defun markdown-follow-link-p ()
- "Jumps between reference links and definitions; between footnote markers
and footnote text.
-Returns t if jumps and nil otherwise."
+ "Jump between reference links and definitions; between footnote markers
and footnote text.
+Return t if jump and nil otherwise."
(cond
;; Footnote definition
((markdown-footnote-text-positions)
@@ -335,7 +335,7 @@ Returns t if jumps and nil otherwise."
(not (hpath:www-at-p)))
(let ((opoint (point))
npoint)
- (cond ((markdown-link-p)
+ (cond ((markdown-link-p)
(condition-case ()
;; Follows a reference link or footnote to its referent.
(if (markdown-follow-link-p)
@@ -627,7 +627,7 @@ Requires the Emacs builtin Tramp library for ftp file
retrievals."
(require 'klink)
;;; ========================================================================
-;;; Links to Hyperbole button types
+;;; Links to Hyperbole button types
;;; ========================================================================
diff --git a/hinit.el b/hinit.el
index c9df41b..9172a8e 100644
--- a/hinit.el
+++ b/hinit.el
@@ -55,7 +55,7 @@
;;;###autoload
(defmacro hui-menu-remove (menu-sym &optional keymap)
- "Remove MENU-SYM menu from any menubars generated by optional KEYMAP or the
global-map."
+ "Remove MENU-SYM menu from any menubars generated by optional KEYMAP or the
`global-map'."
`(prog1 (if (null ,keymap) (setq keymap global-map))
(define-key (or ,keymap global-map) [menu-bar ,menu-sym] nil)
;; Force a menu-bar update.
@@ -73,7 +73,7 @@
(file-directory-p hbmap:dir-user)
(not (file-writable-p (directory-file-name hbmap:dir-user)))))
(error
- "(hyperb:init): `hbmap:dir-user' must be a writable directory name."))
+ "(hyperb:init): `hbmap:dir-user' must be a writable directory name"))
(let ((hbmap:dir-user (directory-file-name hbmap:dir-user)))
(or (file-directory-p hbmap:dir-user) ;; Exists and is writable.
(let* ((parent-dir (file-name-directory
@@ -81,19 +81,19 @@
(cond
((not (file-directory-p parent-dir))
(error
- "(hyperb:init): `hbmap:dir-user' parent dir does not exist."))
+ "(hyperb:init): `hbmap:dir-user' parent dir does not exist"))
((not (file-writable-p parent-dir))
(error
- "(hyperb:init): `hbmap:dir-user' parent directory not writable."))
+ "(hyperb:init): `hbmap:dir-user' parent directory not writable"))
((or (if (fboundp 'make-directory)
(progn (make-directory hbmap:dir-user) t))
(hypb:call-process-p "mkdir" nil nil hbmap:dir-user))
(or (file-writable-p hbmap:dir-user)
(or (progn (hypb:chmod '+ 700 hbmap:dir-user)
(file-writable-p hbmap:dir-user))
- (error "(hyperb:init): Can't write to 'hbmap:dir-user'.")
+ (error "(hyperb:init): Can't write to 'hbmap:dir-user'")
)))
- (t (error "(hyperb:init): `hbmap:dir-user' create failed."))))))
+ (t (error "(hyperb:init): `hbmap:dir-user' create failed"))))))
t)
(provide 'hinit)
diff --git a/hload-path.el b/hload-path.el
index 6204e44..6e7ab26 100644
--- a/hload-path.el
+++ b/hload-path.el
@@ -22,7 +22,7 @@
(locate-file "hmouse-tag.el" load-path)
""))
(error
- "(Hyperbole): Failed to set hyperb:dir. Try setting
it manually."))
+ "(Hyperbole): Failed to set hyperb:dir. Try setting
it manually"))
"Directory where the Hyperbole executable code is kept.
It must end with a directory separator character.")
diff --git a/hmail.el b/hmail.el
index 689bc3e..a385b8b 100644
--- a/hmail.el
+++ b/hmail.el
@@ -66,9 +66,9 @@ Valid values are: nil, Mh-init, Rmail-init or Vm-init."
;;; ========================================================================
(defun hmail:hbdata-start (&optional msg-start msg-end)
- "Returns point immediately before any Hyperbole button data in current msg.
-Returns message end point when no button data is found.
-Has side-effect of widening buffer.
+ "Return point immediately before any Hyperbole button data in current msg.
+Return message end point when no button data is found.
+Has side-effect of widening buffer.
Message's displayable part begins at optional MSG-START and ends at or before
MSG-END."
(widen)
@@ -78,8 +78,8 @@ MSG-END."
(if (search-backward hmail:hbdata-sep msg-start t) (1- (point)) msg-end)))
(defun hmail:hbdata-to-p ()
- "Moves point to Hyperbole but data start in an e-mail msg.
-Returns t if button data is found."
+ "Move point to Hyperbole but data start in an e-mail msg.
+Return t if button data is found."
(and (cond ((memq major-mode (list hmail:reader hmail:modifier))
(hmail:msg-narrow) t)
((or (hmail:lister-p) (hnews:lister-p)) t)
@@ -92,7 +92,7 @@ Returns t if button data is found."
(progn (forward-line 1) t)))))
(defun hmail:browser-p ()
- "Returns t iff current major mode helps browse received e-mail messages."
+ "Return t iff current major mode helps browse received e-mail messages."
(memq major-mode (list hmail:reader hmail:lister)))
(defun hmail:buffer (&optional buf invisible-flag)
@@ -123,7 +123,7 @@ Optional SUBJECT and HELP message may also be given."
"Replace subject, compose message, and then mail.")))
(defun hmail:composing-dir (key-src)
- "If button KEY-SRC is a mail/news composure buffer, returns composure
directory, else nil."
+ "If button KEY-SRC is a mail/news composure buffer, return composure
directory, else nil."
(save-excursion
(and (bufferp key-src)
(progn (set-buffer key-src)
@@ -132,11 +132,11 @@ Optional SUBJECT and HELP message may also be given."
default-directory)))
(defun hmail:editor-p ()
- "Returns t iff current major mode edits Hyperbole e-mail/news messages."
+ "Return t iff current major mode edits Hyperbole e-mail/news messages."
(memq major-mode (list hmail:composer hnews:composer hmail:modifier)))
(defun hmail:init (class-prefix func-suffix-list)
- "Sets up CLASS-PREFIX functions with aliases for FUNC-SUFFIX-LIST.
+ "Set up CLASS-PREFIX functions with aliases for FUNC-SUFFIX-LIST.
`hmail:reader' should be set appropriately before this is called."
(when hmail:reader
(let* ((reader-name (symbol-name hmail:reader))
@@ -163,15 +163,15 @@ Optional arguments are ADDRESS, CC list and SUBJECT of
mail."
(defun hmail:lister-p ()
- "Returns t iff current major mode is a Hyperbole e-mail lister mode."
+ "Return t iff current major mode is a Hyperbole e-mail lister mode."
(eq major-mode hmail:lister))
(defun hnews:lister-p ()
- "Returns t iff current major mode is a Hyperbole news summary lister mode."
+ "Return t iff current major mode is a Hyperbole news summary lister mode."
(eq major-mode hnews:lister))
(defun hmail:mode-is-p ()
- "Returns current major mode if a Hyperbole e-mail or news mode, else nil."
+ "Return current major mode if a Hyperbole e-mail or news mode, else nil."
(car (memq major-mode
(list hmail:reader hmail:composer hmail:lister hmail:modifier
hnews:reader hnews:composer hnews:lister))))
@@ -187,7 +187,7 @@ MSG-END."
(narrow-to-region msg-start (hmail:hbdata-start msg-start msg-end)))
(defun hmail:reader-p ()
- "Returns t iff current major mode shows received Hyperbole e-mail messages."
+ "Return t iff current major mode show received Hyperbole e-mail messages."
(memq major-mode (list hmail:reader hmail:modifier)))
(defun hmail:region (start end &optional buf invisible-flag)
@@ -214,7 +214,7 @@ buffer. It may be a buffer or buffer name."
;;; ========================================================================
(defun rmail:init ()
- "Initializes Hyperbole abstract mail interface for a particular mail reader.
+ "Initialize Hyperbole abstract mail interface for a particular mail reader.
`hmail:reader' should be set appropriately before this is called."
(hmail:init "rmail:" '("msg-hdrs-full" "msg-narrow" "msg-num"
"msg-prev" "msg-next"
@@ -227,7 +227,7 @@ buffer. It may be a buffer or buffer name."
"String header preceding an e-mail received message-id.")
(defun rmail:msg-id-get ()
- "Returns current msg id for an `hmail:reader' buffer as a string, else nil.
+ "Return current msg id for an `hmail:reader' buffer as a string, else nil.
Signals error when current mail reader is not supported."
(let* ((reader (symbol-name hmail:reader))
;; (toggled)
diff --git a/hmh.el b/hmh.el
index 919903b..af48cbd 100644
--- a/hmh.el
+++ b/hmh.el
@@ -39,7 +39,7 @@
;;;###autoload
(defun Mh-init ()
- "Initializes Hyperbole support for Mh mail reading."
+ "Initialize Hyperbole support for Mh mail reading."
(interactive)
(setq hmail:composer 'mh-letter-mode
hmail:lister 'mh-folder-mode
@@ -74,21 +74,21 @@ For now, a no-op."
)
(defun Mh-msg-narrow ()
- "Narrows mail reader buffer to current message.
+ "Narrow mail reader buffer to current message.
This includes Hyperbole button data."
(Mh-msg-widen))
(defun Mh-msg-next () (mh-next-undeleted-msg 1))
(defun Mh-msg-num ()
- "Returns number of mail message that point is within."
+ "Return number of mail message that point is within."
(interactive)
(mh-get-msg-num nil))
(defun Mh-msg-prev () (mh-previous-undeleted-msg 1))
(defun Mh-msg-to-p (mail-msg-id mail-file)
- "Sets current buffer to start of msg with MAIL-MSG-ID in MAIL-FILE.
+ "Set current buffer to start of msg with MAIL-MSG-ID in MAIL-FILE.
Returns t if successful, else nil."
(if (not (file-readable-p mail-file))
nil
@@ -102,7 +102,7 @@ Returns t if successful, else nil."
(Mh-to) (widen))
(defun Mh-to ()
- "Sets current buffer to a mail reader buffer."
+ "Set current buffer to a mail reader buffer."
(and (eq major-mode 'Mh-folder-mode)
(set-buffer mh-show-buffer)))
@@ -116,7 +116,7 @@ Returns t if successful, else nil."
(mh-show msg-num)))
(defun Mh-Summ-to ()
- "Sets current buffer to a mail listing buffer."
+ "Set current buffer to a mail listing buffer."
(let ((summ-buf))
(save-excursion
(mapc (lambda (window)
diff --git a/hmoccur.el b/hmoccur.el
index e313d3f..789511f 100644
--- a/hmoccur.el
+++ b/hmoccur.el
@@ -20,21 +20,21 @@
;; Subject: moccur - multibuffer occurences
;;
;; While editing some dozen or so files, i had the dire need for
-;; something like 'occur' that can cope with multiple buffers. This has
-;; probably been done before; but still, here is my try at it. It seems
+;; something like 'occur' that can cope with multiple buffers. This has
+;; probably been done before; but still, here is my try at it. It seems
;; to be very useful.
;;
-;; How to use it: simple say
-;; M-x moccur <regexp>
+;; How to use it: simple say
+;; M-x moccur <regexp>
;; moccur then searches through *all buffers* currently existing that are
;; bound to files and displays the occurences in a buffer that runs in
-;; Moccur-mode. Change to that buffer, scroll around, and say C-c C-c
-;; to jump to the occurrence. Quite simple.
+;; Moccur-mode. Change to that buffer, scroll around, and say C-c C-c
+;; to jump to the occurrence. Quite simple.
;;
-;; Incompatibilites to Occur mode:
+;; Incompatibilites to Occur mode:
;; a) it browses through *all* buffers that have a file name
;; associated with them; those may or may not include the current
-;; buffer. Especially, while standard occur works
+;; buffer. Especially, while standard occur works
;; on 'all lines following point', Moccur does not.
;; b) there is no support for the 'NLINE' argument.
;;
@@ -184,7 +184,7 @@ serves as a menu to find any of the occurrences in this
buffer.
"Return (destination-buffer line-number occur-match-text) for the current
moccur buffer line.
Signal an error if not on a valid occurrence line."
(if (not (eq major-mode 'moccur-mode))
- (error "'moccur-to' must be called within a moccur buffer.")
+ (error "'moccur-to' must be called within a moccur buffer")
(let (beg file-path lineno dstbuf occur-match)
(save-excursion
(beginning-of-line)
diff --git a/hmouse-drv.el b/hmouse-drv.el
index 8142cdf..3cdc15b 100644
--- a/hmouse-drv.el
+++ b/hmouse-drv.el
@@ -785,7 +785,7 @@ Return non-nil iff associated help documentation is found."
(if (and (consp call) (eq (car call) 'call-interactively))
(if (consp (cadr call))
(setq cmd-sym (if (memq (caadr call) '(function quote))
- (cadadr call)
+ (cadadr call)
(caadr call)))))
(setq calls (if (and (consp call) (eq (car call) 'or))
(mapcar 'identity (cdr call))
@@ -958,7 +958,7 @@ Return t if help is displayed, nil otherwise."
(hmouse-function #'hkey-assist-help assist-flag args)
t)))
(when help-shown
- ;; Then both Smart Keys have been released.
+ ;; Then both Smart Keys have been released.
(setq action-key-cancelled nil
assist-key-cancelled nil)
t))))
@@ -1162,7 +1162,7 @@ the position (not below another application's window)."
(defun hmouse-window-coordinates (&optional event)
"Return a list (window (x-chars . y-chars)) for optional EVENT.
Always ignores EVENT coordinates and uses current mouse position.
-The area of the EVENT is utilized. If EVENT is not given and the
+The area of the EVENT is utilized. If EVENT is not given and the
free variable `assist-flag' is non-nil, EVENT is set to
`assist-key-release-args', otherwise, `action-key-release-args'.
@@ -1262,7 +1262,7 @@ Under InfoDock and XEmacs, `zmacs-region' must be t;
under GNU Emacs,
(add-hook 'mouse-leave-buffer-hook #'hmouse-save-region)
;; BW - Last confirmed in 1999, for some reason, using this next
-;; function in byte-compiled form caused the first character
+;; function in byte-compiled form caused the first character
;; after a mouse key depress to be dropped from the input queue when running
;; Emacs under X. The non-byte-compiled form always worked fine. We
;; assume this is no longer a problem in 2016 but have this note here
@@ -1278,7 +1278,7 @@ return current point as a marker."
(list 'keyboard-drag (posn-at-point))))
(defun hmouse-set-point-at (set-point-arg-list)
- "Set point to cursor position using SET-POINT-ARG-LIST and returns t.
+ "Set point to cursor position using SET-POINT-ARG-LIST and return t.
If 'hmouse-set-point-command' is not bound to a function, this does nothing
and returns nil."
(if (fboundp hmouse-set-point-command)
@@ -1318,7 +1318,7 @@ is not bound to a valid function."
(setq action-key-release-window (hmouse-key-release-window)
action-key-release-prev-point (point-marker)))
(and (eq major-mode 'br-mode)
- (setq action-mouse-key-prev-window
+ (setq action-mouse-key-prev-window
(if (br-in-view-window-p)
(save-window-excursion
(br-next-listing-window)
diff --git a/hmouse-info.el b/hmouse-info.el
index f81b389..a6ee585 100644
--- a/hmouse-info.el
+++ b/hmouse-info.el
@@ -56,7 +56,7 @@ If key is pressed within:
is found;
(2) the Up, Next, or Previous entries of a Node Header (first line),
the desired node is found;
- (3) the File entry of a Node Header (first line),
+ (3) the File entry of a Node Header (first line),
the `Top' node within that file is found;
(4) at the end of the current node, the Next node is found (this will
descend subtrees if the function `Info-global-next' is bound);
@@ -67,7 +67,7 @@ Returns t if key is pressed within an Info Node Header, Cross
Reference,
or a Menu; otherwise returns nil."
(interactive)
- (cond
+ (cond
;;
;; If at end of node, go to next node
;;
@@ -95,14 +95,14 @@ or a Menu; otherwise returns nil."
;;;###autoload
(defun smart-info-assist ()
- "Walks through Info documentation networks using one assist-key or mouse
assist-key.
+ "Walk through Info documentation networks using one assist-key or mouse
assist-key.
If assist-key is pressed within:
(1) the first line of an Info Menu Entry or Cross Reference, the desired node
is found;
(2) the Up, Next, or Previous entries of a Node Header (first line),
the last node in the history list is found;
- (3) the File entry of a Node Header (first line),
+ (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);
@@ -164,7 +164,7 @@ Otherwise, return nil."
(if filep " ")
"]*\\)") nil t)
(setq nodename (match-string-no-properties 1))))
- (error "Node header not found.")))
+ (error "Node header not found")))
(setq nodename
(cond ((eq (aref nodename 0) ?\() nodename)
(filep (concat "(" nodename ")" "Top"))
@@ -175,7 +175,7 @@ Otherwise, return nil."
(defun Info-handle-in-node-hdr-assist ()
"If within an Info node header when the `smart-info-assist' command is
-executed, when within the <FILE> header go to the DIR top-level node. When
+executed, when within the <FILE> header go to the DIR `top-level node'. When
within any other header (<Up>, <Previous>, or <Next>) go to last node from
history list. Return t if in Info node header. Otherwise return nil."
;;
@@ -183,7 +183,7 @@ history list. Return t if in Info node header. Otherwise
return nil."
;;
(when (first-line-p)
(save-excursion
- (if (and
+ (if (and
(re-search-forward "[:, \t\n\r]" nil t)
(re-search-backward
"\\(File\\|Node\\|Up\\|Prev\\|Previous\\|Next\\):[ \t]" nil t) )
@@ -194,7 +194,7 @@ history list. Return t if in Info node header. Otherwise
return nil."
(Info-directory)
(Info-last))
t)
- (error "Node header not found.")
+ (error "Node header not found")
nil))))
;;;###autoload
@@ -353,7 +353,7 @@ This works regardless of the current buffer."
" " t)))))
(defun Info-read-index-item-name-1 (string predicate code)
- "Internal function used by `Info-read-index-item-name'to generate
completions.
+ "Internal function used by `Info-read-index-item-name' to generate
completions.
See `completing-read' for a description of arguments and usage."
(cond
;; First complete embedded file names.
diff --git a/hmouse-key.el b/hmouse-key.el
index 5ea6696..81e8e60 100644
--- a/hmouse-key.el
+++ b/hmouse-key.el
@@ -49,7 +49,7 @@ Returns t iff the key is properly bound, else nil."
(where-is-internal 'assist-mouse-key-emacs (current-global-map) t)))
(defun hmouse-set-bindings (key-binding-list)
- "Sets mouse keys used as Smart Keys to bindings in KEY-BINDING-LIST.
+ "Set mouse keys used as Smart Keys to bindings in KEY-BINDING-LIST.
KEY-BINDING-LIST is the value of either `hmouse-previous-bindings'
\(mouse bindings prior to Smart Key setup) or `hmouse-bindings' (mouse
bindings after Smart Key setup."
@@ -65,7 +65,7 @@ bindings after Smart Key setup."
key-binding-list))))
(defun hmouse-install (&optional arg)
- "Binds the two rightmost shifted mouse keys to the Action and Assist Keys,
initializing Hyperbole mouse buttons.
+ "Bind the two rightmost shifted mouse keys to the Action and Assist Keys,
initializing Hyperbole mouse buttons.
With optional prefix ARG or under InfoDock, also binds the unshifted middle
mouse key to the Action Key.
The standard Hyperbole configuration is Action Key = shift-middle mouse key;
@@ -89,13 +89,13 @@ Assist Key = shift-right mouse key."
"{Shift-Mouse-2} invokes"))))
(defun hmouse-add-unshifted-smart-keys ()
- "Binds mouse-2 to the Action Key and mouse-3 to the Assist Key."
+ "Bind mouse-2 to the Action Key and mouse-3 to the Assist Key."
(interactive)
(require 'hyperbole)
(hmouse-unshifted-setup))
(defun hmouse-toggle-bindings ()
- "Toggles between Smart Mouse Key settings and their prior bindings.
+ "Toggle between Smart Mouse Key settings and their prior bindings.
Under InfoDock, the first invocation of this command will make the middle
mouse key the Paste Key instead of the Action Key."
(interactive)
@@ -113,12 +113,12 @@ mouse key the Paste Key instead of the Action Key."
(if (called-interactively-p 'interactive)
(message "%s mouse bindings are now in use."
(if hmouse-bindings-flag "Hyperbole" "Non-Hyperbole"))))
- (error "(hmouse-toggle-bindings): `%s' is empty."
+ (error "(hmouse-toggle-bindings): `%s' is empty"
(if hmouse-bindings-flag 'hmouse-previous-bindings
'hmouse-bindings)))))
;; Define function to reload Smart Key bindings and actions after a source
code change.
(defun hmouse-update-smart-keys ()
- "Reloads the contexts and actions associated with the Smart Keys after any
programmatic changes are made."
+ "Reload the contexts and actions associated with the Smart Keys after any
programmatic change is made."
(interactive)
(hkey-initialize)
(makunbound 'hkey-alist)
diff --git a/hmouse-mod.el b/hmouse-mod.el
index 4417e2f..ab977a4 100644
--- a/hmouse-mod.el
+++ b/hmouse-mod.el
@@ -70,7 +70,7 @@
(defvar hmouse-mod--global-map nil
"Global key map installed by `hmouse-mod-enable' function.
-Translates self-insert-command characters into control and meta characters if
+Translates `self-insert-command' characters into control and meta characters if
the Action or Assist Keys are depressed at the time of key press.")
(defvar hmouse-mod--prior-global-map nil
@@ -114,16 +114,16 @@ mode, if no other key is pressed while a Smart Key is
depressed."
;;; ************************************************************************
(defun hmouse-mod-disable ()
- "Restores the global keymap to its state prior to enabling of
`hmouse-mod-mode'.
+ "Restore the global keymap to its state prior to enabling of
`hmouse-mod-mode'.
This stops the Smart Keys from acting as modifier keys."
(use-global-map (if (keymapp hmouse-mod--prior-global-map)
hmouse-mod--prior-global-map
global-map)))
(defun hmouse-mod-enable ()
- "Creates `hmouse-mod--global-map' and installs it as the current global map.
+ "Create `hmouse-mod--global-map' and install it as the current global map.
It accounts for modifier Smart Keys."
- (error "(hmouse-mod-mode): Don't use this; it conflicts with Emacs mouse
bindings.")
+ (error "(hmouse-mod-mode): Don't use this; it conflicts with Emacs mouse
bindings")
(setq hmouse-mod--global-map (copy-keymap global-map))
(substitute-key-definition
@@ -135,7 +135,7 @@ It accounts for modifier Smart Keys."
(use-global-map hmouse-mod--global-map))
(defun hmouse-mod-execute-command (key count)
- "Executes the command associated with keyboard KEY or if KEY is a prefix,
records it.
+ "Execute the command associated with keyboard KEY or if KEY is a prefix,
records it.
Second argument COUNT is used as a prefix argument to the command."
(if (stringp key) (setq key (concat hmouse-mod--prefix key)))
(let ((binding (key-binding key))
@@ -151,11 +151,11 @@ Second argument COUNT is used as a prefix argument to the
command."
binding)))
((symbolp binding)
(setq hmouse-mod--prefix nil)
- (error "(hmouse-mod-execute-command): {%s} not bound to a command."
+ (error "(hmouse-mod-execute-command): {%s} not bound to a command"
key))
((integerp binding)
(setq hmouse-mod--prefix nil)
- (error "(hmouse-mod-execute-command): {%s} invalid key sequence."
+ (error "(hmouse-mod-execute-command): {%s} invalid key sequence"
(key-description (vector key))))
((stringp key)
(or noninteractive (message (key-description key)))
diff --git a/hmouse-sh.el b/hmouse-sh.el
index b84d770..108ffb0 100644
--- a/hmouse-sh.el
+++ b/hmouse-sh.el
@@ -149,7 +149,7 @@ Use nil as cmd values to unbind a key. Works under GNU
Emacs only."
))))
(defun hmouse-bind-shifted-key-emacs (shifted-mouse-key-number depress-cmd
release-cmd)
- "Ensure shifted MOUSE-KEY-NUMBER (1-5), e.g. 1 for [Smouse-1], is globally
bound to DEPRESS-CMD and RELEASE-CMD (includes depresses and drags).
+ "Ensure SHIFTED-MOUSE-KEY-NUMBER (1-5), e.g. 1 for [Smouse-1], is globally
bound to DEPRESS-CMD and RELEASE-CMD (includes depresses and drags).
Use nil as CMD value to unbind the key. Works under GNU Emacs only."
(hmouse-set-key-list
depress-cmd
@@ -392,7 +392,7 @@ Select the corresponding window as well."
(defun hmouse-move-point-emacs (event &optional promote-to-region)
"Move point to the position clicked on with the mouse.
This should be bound to a mouse click event type.
-If PROMOTE-TO-REGION is non-nil and event is a multiple-click,
+If PROMOTE-TO-REGION is non-nil and EVENT is a multiple-click,
select the corresponding element around point, with the resulting position of
point determined by `mouse-select-region-move-to-beginning'."
(interactive "e\np")
@@ -467,8 +467,8 @@ point determined by
`mouse-select-region-move-to-beginning'."
hmouse-bindings-flag t)))
(defun hmouse-unshifted-setup (&optional middle-key-only-flag)
- "Binds the middle mouse key as the Action Key and the right mouse key as the
Assist Key.
-With optional MIDDLE-KEY-ONLY-FLAG non-nil, binds only the middle mouse key."
+ "Bind the middle mouse key as the Action Key and the right mouse key as the
Assist Key.
+With optional MIDDLE-KEY-ONLY-FLAG non-nil, bind only the middle mouse key."
(interactive)
;; Unbind Emacs push-button mouse keys since Hyperbole handles them.
(define-key button-map [mouse-2] nil)
diff --git a/hmouse-tag.el b/hmouse-tag.el
index 2cb4949..30d5aba 100644
--- a/hmouse-tag.el
+++ b/hmouse-tag.el
@@ -263,7 +263,7 @@ Otherwise:
identifier)))))
(defun smart-c (&optional identifier next list-of-tags-tables)
- "Jumps to the definition of optional C IDENTIFIER or the one at point.
+ "Jump to the definition of optional C IDENTIFIER or the one at point.
Optional second arg NEXT means jump to next matching C tag.
It assumes that its caller has already checked that the key was pressed in an
@@ -347,7 +347,7 @@ If:
nil)
(defun smart-emacs-lisp-mode-p ()
- "Return t if in a mode which uses Emacs Lisp symbols."
+ "Return t if in a mode which use Emacs Lisp symbols."
;; Beyond Lisp files, Emacs Lisp symbols appear frequently in Byte-Compiled
;; buffers, debugger buffers, and Help buffers.
(or (memq major-mode #'(emacs-lisp-mode lisp-interaction-mode debugger-mode))
@@ -495,7 +495,7 @@ If key is pressed:
;;;###autoload
(defun smart-javascript (&optional identifier next)
- "Jumps to the definition of optional JavaScript IDENTIFIER or the one at
point.
+ "Jump to the definition of optional JavaScript IDENTIFIER or the one at
point.
Optional second arg NEXT means jump to next matching JavaScript tag.
It assumes that its caller has already checked that the key was pressed in an
@@ -545,7 +545,7 @@ in the current directory or any of its ancestor
directories."
(point) (match-end 0))))))))
(defun smart-lisp (&optional show-doc)
- "Jumps to the definition of any selected Lisp identifier or optionally
SHOW-DOC.
+ "Jump to the definition of any selected Lisp identifier or optionally
SHOW-DOC.
If on an Emacs Lisp require, load, or autoload clause and the
`find-library' function from the \"load-library\" package has
been loaded, this jumps to the library source whenever possible.
@@ -618,7 +618,7 @@ buffer."
(error "(smart-lisp): `%s' definition not found in
any tag table" tag)))))))))
(defun smart-lisp-at-definition-p ()
- "Returns t when point is in a non-help buffer on the first line of a
non-alias Lisp definition, else nil."
+ "Return t when point is in a non-help buffer on the first line of a
non-alias Lisp definition, else nil."
(unless (derived-mode-p 'help-mode)
(save-excursion
(beginning-of-line)
@@ -630,7 +630,7 @@ buffer."
(not (looking-at "\\(;*[ \t]*\\)?(default"))))))
(defun smart-lisp-at-load-expression-p ()
- "Returns t when point is on the first line of a Lisp library load
expression, else nil."
+ "Return t when point is on the first line of a Lisp library load
expression, else nil."
(save-excursion
(beginning-of-line)
(looking-at "\\(;*[ \t]*\\)?(\\(autoload\\|load\\|require\\)")))
@@ -645,7 +645,7 @@ Returns matching ELisp tag name that point is within, else
nil."
(string-match "[^-]-[^-]" identifier)))))
(defun smart-lisp-at-tag-p (&optional no-flash)
- "Returns Lisp tag name that point is within, else nil.
+ "Return Lisp tag name that point is within, else nil.
Returns nil when point is on the first line of a non-alias Lisp definition."
(unless (smart-lisp-at-definition-p)
(let* ((identifier-chars "-_:/*+=%$&?!<>a-zA-Z0-9~^")
@@ -671,13 +671,13 @@ Returns nil when point is on the first line of a
non-alias Lisp definition."
;;;###autoload
(defun smart-lisp-mode-p ()
- "Return t if in a mode which uses Lisp symbols."
+ "Return t if in a mode which use Lisp symbols."
(or (smart-emacs-lisp-mode-p)
(memq major-mode '(lisp-mode scheme-mode))))
;;;###autoload
(defun smart-objc (&optional identifier next)
- "Jumps to the definition of optional Objective-C IDENTIFIER or the one at
point.
+ "Jump to the definition of optional Objective-C IDENTIFIER or the one at
point.
Optional second arg NEXT means jump to next matching Objective-C tag.
It assumes that its caller has already checked that the key was pressed in an
@@ -730,7 +730,7 @@ Otherwise:
;;; The following should be called only if the OO-Browser is available.
(defun smart-objc-oo-browser (&optional junk)
- "Jumps to the definition of selected Objective-C construct via OO-Browser
support.
+ "Jump to the definition of selected Objective-C construct via OO-Browser
support.
Optional JUNK is ignored. Does nothing if the OO-Browser is not available.
It assumes that its caller has already checked that the key was pressed in an
@@ -771,7 +771,7 @@ If key is pressed:
(match-beginning 2) (match-end 2)))))))
(defun smart-jedi-find-file (file line column other-window)
- "Function that reads a source file for jedi navigation.
+ "Function that read a source FILE for jedi navigation.
It takes these arguments: (file-to-read other-window-flag line_number
column_number)."
(hpath:display-buffer (find-file file) other-window)
(jedi:goto--line-column line column))
@@ -893,7 +893,7 @@ If key is pressed:
;;; ************************************************************************
(defun smart-ancestor-tag-files (&optional path name-of-tags-file)
- "Walk up path tree looking for tags files and return list from furthest to
deepest (nearest)."
+ "Walk up PATH tree looking for NAME-OF-TAGS-FILE and return list from
furthest to deepest (nearest)."
(or path (setq path default-directory))
(let ((tags-table-list)
tags-file)
@@ -911,10 +911,10 @@ If key is pressed:
tags-table-list))
(defun smart-asm-include-file ()
- "If point is on an include file line, tries to display file.
+ "If point is on an include file line, try to display file.
Returns non-nil iff on an include file line, even if file is not found.
Look for include file in `smart-asm-include-path' and add suffix \".ins\" or
-\".inc\" to filename if it lacks a suffix."
+\".inc\" to filename if it lacks a suffix."
(let ((opoint (point)))
;; Some assemblers utilize the C preprocessor, so try that first.
(cond ((smart-c-include-file))
@@ -955,7 +955,7 @@ Look for include file in `smart-asm-include-path' and add
suffix \".ins\" or
nil))))
(defun smart-c-include-file ()
- "If point is on an include file line, tries to display file.
+ "If point is on an include file line, try to display file.
Returns non-nil iff on an include file line, even if file is not found.
Look for include file in `smart-c-cpp-include-path' and in directory list
`smart-c-include-path'."
@@ -1000,7 +1000,7 @@ Look for include file in `smart-c-cpp-include-path' and
in directory list
nil)))
(defun smart-flash-tag (tag start end)
- "Tries to flash TAG at START to END in buffer, to indicate that it is
serving as a hyperlink button.
+ "Try to flash TAG at START to END in buffer, to indicate that it is serving
as a hyperlink button.
Returns TAG."
;; Button flashing code might not yet have been loaded if the whole
;; Hyperbole system has not been started.
@@ -1011,7 +1011,7 @@ Returns TAG."
tag)
(defun smart-lisp-at-known-identifier-p ()
- "Returns non-nil if point is within a Lisp identifier listed in a tags table
or is a known Emacs Lisp identifier, else nil."
+ "Return non-nil if point is within a Lisp identifier listed in a tags table
or is a known Emacs Lisp identifier, else nil."
(interactive)
(unless (and (fboundp 'find-library)
;; Handle Emacs Lisp `require', `load', and `autoload' clauses.
@@ -1043,7 +1043,7 @@ Returns TAG."
(condition-case () (find-definition-noselect tag-sym 'defface) (error
nil)))))
(defun smart-tags-find-p (tag)
- "Returns non-nil if TAG is found within a tags table, else nil."
+ "Return non-nil if TAG is found within a tags table, else nil."
(let* ((tags-table-list (or (and (boundp 'tags-table-list) tags-table-list)
(smart-tags-file-list)))
(func (smart-tags-noselect-function))
@@ -1067,7 +1067,7 @@ Returns TAG."
(error nil))))
(defun smart-java-cross-reference ()
- "If within a Java @see comment, displays the associated definition for
editing and returns non-nil, else nil.
+ "If within a Java @see comment, displays the associated definition for
editing and return non-nil, else nil.
Non-nil is returned even if the @see referent cannot be found.
Does nothing if the `oo-browser' command is undefined, since it requires that
@@ -1147,9 +1147,9 @@ package for class and feature lookups."
(setq class (buffer-substring-no-properties
(match-beginning
java-class-def-name-grpn)
(match-end
java-class-def-name-grpn)))
- (error "(smart-java-cross-reference): This @see
must be in a class definition.")))
+ (error "(smart-java-cross-reference): This @see
must be in a class definition")))
(br-edit-feature class feature t)))
- (error "(smart-java-cross-reference): The OO-Browser failed to
load a Java environment.")))))
+ (error "(smart-java-cross-reference): The OO-Browser failed to
load a Java environment")))))
;; Return to original point.
(goto-char opoint)
nil)))
@@ -1172,7 +1172,7 @@ package for class and feature lookups."
library-path))
(defun smart-java-packages ()
- "If point is on a `package' or `import' line, this tries to display the
associated referent.
+ "If point is on a `package' or `import' line, this try to display the
associated referent.
Returns non-nil iff on such a line, even if the referent is not found.
Look for packages in `smart-java-package-path'."
(let ((opoint (point)))
@@ -1188,7 +1188,7 @@ Look for packages in `smart-java-package-path'."
(if (string-equal keyword-type "package")
(let ((library-path (smart-java-library-path referent)))
(if library-path
- (hpath:find (expand-file-name
+ (hpath:find (expand-file-name
(hypb:replace-match-string
"\\." referent (file-name-as-directory "") t)
library-path))
@@ -1279,7 +1279,7 @@ See the \"${hyperb:dir}/smart-clib-sym\" script for more
information."
;; when `next' is false (otherwise tag would = nil and the following
;; stringp test would fail).
(if (featurep 'infodock)
- (if (stringp tag)
+ (if (stringp tag)
(setq tag (list tag))))
(if (and func (setq find-tag-result (funcall func tag)))
(cond ((eq func 'find-tag-internal)
@@ -1362,7 +1362,7 @@ to look. If no tags file is found, an error is signaled."
(list buffer-tag-table))
((and (boundp 'tags-file-name) tags-file-name)
(list tags-file-name))
- (t (error "Needed tags file not found; see `man etags' for how to
build one.")))))
+ (t (error "Needed tags file not found; see `man etags' for how to
build one")))))
;;; ************************************************************************
;;; Private functions
diff --git a/hpath.el b/hpath.el
index 364e79b..e48e687 100644
--- a/hpath.el
+++ b/hpath.el
@@ -32,8 +32,8 @@
;;; ************************************************************************
(defcustom hpath:find-file-urls-mode nil
- "This is `t' when a remote file access library is available and use of ftp
and http urls in file finding commands has been enabled.
-Default is `nil' since this can slow down normal file finding."
+ "This is t when a remote file access library is available and use of ftp and
http urls in file finding commands has been enabled.
+Default is nil since this can slow down normal file finding."
:type 'boolean
:initialize #'custom-initialize-default
:set (lambda (_symbol _value) (call-interactively
#'hpath:find-file-urls-mode))
@@ -85,7 +85,7 @@ If the value of 'hpath:mswindows-mount-prefix' changes, then
re-initialize this
(defvar hpath:directory-expand-alist nil
"Automatically set alist of (posix-mount-point . window-path-prefix)
elements.
- Used to expand windows prefixes to posix mount points during
mswindows-to-posix.")
+Used to expand windows prefixes to posix mount points during
mswindows-to-posix.")
;;;###autoload
(defun hpath:mswindows-to-posix (path)
@@ -441,7 +441,7 @@ Its match groupings and their names are:
"\\([a-zA-Z0-9][^/:@ \t\n\r\"`'|]*\\.[^/:@ \t\n\r\"`'|]+\\)"
":?\\([0-9]+\\)?\\([/~]\\([^\]\[@ \t\n\r\"`'|(){}<>]+[^\]\[@
\t\n\r\"`'|(){}<>.,?#!*]\\)*\\)?\\)>?")
"Regular expression which matches a Url in a string or buffer.
- Its match groupings and their names are:
+Its match groupings and their names are:
1 = hpath:url-keyword-grpn = required `URL:' or `URL=' literal
2 = hpath:url-grpn = the whole URL
3 = unused = for compatibility with hpath:url-regexp
@@ -472,17 +472,17 @@ See doc for `hpath:url-regexp' and
`hpath:url-regexp[2,3]'.")
(defvar hpath:string-url-regexp (concat "\\`" hpath:url-regexp "\\'")
"Regular expression that matches to a string that contains a possibly
delimited Url and nothing else.
See the documentation for `hpath:url-regexp' for match groupings to
-use with string-match.")
+use with `string-match'.")
(defvar hpath:string-url-regexp2 (concat "\\`" hpath:url-regexp2 "\\'")
"Regular expression that matches to a string that contains a possibly
delimited terse Url and nothing else.
See the documentation for `hpath:url-regexp' for match groupings to
-use with string-match.")
+use with `string-match'.")
(defvar hpath:string-url-regexp3 (concat "\\`" hpath:url-regexp3 "\\'")
"Regular expression that matches to a string that contains a possibly
delimited terse Url and nothing else.
See the documentation for `hpath:url-regexp' for match groupings to
-use with string-match.")
+use with `string-match'.")
;;; ************************************************************************
;;; Private variables
@@ -526,7 +526,7 @@ These are used to indicate how to display or execute the
pathname.
;;; ************************************************************************
(defun hpath:absolute-to (path &optional default-dirs)
- "Returns PATH as an absolute path relative to one directory from optional
DEFAULT-DIRS or `default-directory'.
+ "Return PATH as an absolute path relative to one directory from optional
DEFAULT-DIRS or `default-directory'.
Returns PATH unchanged when it is not a valid path or when DEFAULT-DIRS
is invalid. DEFAULT-DIRS when non-nil may be a single directory or a list of
directories. The first one in which PATH is found is used."
@@ -549,7 +549,7 @@ directories. The first one in which PATH is found is used."
(or rtn path)))))
(defun hpath:tramp-file-name-regexp ()
- "Returns a modified tramp-file-name-regexp for matching to the beginning of
a remote file name.
+ "Return a modified `tramp-file-name-regexp' for matching to the beginning of
a remote file name.
Removes bol anchor and removes match to empty string if present."
(let ((tramp-regexp (car (if (fboundp 'tramp-file-name-structure)
(tramp-file-name-structure)
@@ -557,7 +557,7 @@ Removes bol anchor and removes match to empty string if
present."
(substring-no-properties (replace-regexp-in-string "\\\\'" ""
tramp-regexp) 1)))
(defun hpath:remote-at-p ()
- "Returns a remote pathname that point is within or nil.
+ "Return a remote pathname that point is within or nil.
See the `(emacs)Remote Files' info documentation for pathname format details.
Always returns nil if (hpath:remote-available-p) returns nil."
(let ((remote-package (hpath:remote-available-p))
@@ -622,8 +622,8 @@ Always returns nil if (hpath:remote-available-p) returns
nil."
(hpath:delete-trailer path))))
(defun hpath:remote-p (path)
- "Returns a normalized form of PATH if it is a remote, non-local, pathname,
else nil.
-See the `(Tramp)Top' Emacs lisp package manual for remote pathname format
details.
+ "Return a normalized form of PATH if it is a remote, non-local, pathname,
else nil.
+See the `(Tramp)Top' Emacs Lisp package manual for remote pathname format
details.
Always returns nil if (hpath:remote-available-p) returns nil."
(and (stringp path)
(let ((remote-package (hpath:remote-available-p))
@@ -691,7 +691,7 @@ Always returns nil if (hpath:remote-available-p) returns
nil."
(hpath:delete-trailer result))))
(defun hpath:at-p (&optional type non-exist)
- "Returns delimited path or non-delimited remote path at point, if any.
+ "Return delimited path or non-delimited remote path at point, if any.
World-Wide Web urls are ignored and therefore dealt with by other code.
Delimiters may be: double quotes, open and close single quote, whitespace, or
Texinfo file references. If optional TYPE is the symbol 'file or 'directory,
@@ -706,7 +706,7 @@ paths are allowed. Absolute pathnames must begin with a
`/' or `~'."
((hpath:is-p (hpath:delimited-possible-path non-exist) type non-exist))))
(defun hpath:delimited-possible-path (&optional non-exist include-positions)
- "Returns delimited possible path or non-delimited remote path at point, if
any.
+ "Return delimited possible path or non-delimited remote path at point, if
any.
No validity checking is done on the possible path. Delimiters may be:
double quotes, open and close single quote, whitespace, or Texinfo file
references.
@@ -739,7 +739,7 @@ end-pos) or nil."
;;;###autoload
(defun hpath:display-buffer (buffer &optional display-where)
- "Displays and selects BUFFER at optional DISPLAY-WHERE location or at
`hpath:display-where'.
+ "Display and select BUFFER at optional DISPLAY-WHERE location or at
`hpath:display-where'.
BUFFER must be a buffer or a buffer name.
See the documentation of `hpath:display-buffer-alist' for valid
@@ -760,7 +760,7 @@ is displayed or nil if not displayed because BUFFER is
invalid."
(selected-window)))
(defun hpath:display-buffer-other-frame (buffer)
- "Displays and selects BUFFER, in another frame.
+ "Display and select BUFFER, in another frame.
BUFFER must be a buffer or a buffer name.
May create a new frame, or reuse an existing one. See
@@ -779,7 +779,7 @@ window in which the buffer is displayed."
(selected-window))
(defun hpath:find (filename &optional display-where)
- "Edits file FILENAME using user customizable settings of display program and
location.
+ "Edit file FILENAME using user customizable settings of display program and
location.
FILENAME may start with a special prefix character which is
handled as follows:
@@ -887,7 +887,7 @@ program)."
(goto-char opoint)
(error "(hpath:to-markup-anchor): Anchor `%s' not found in
the visible buffer portion"
anchor))))
- (t
+ (t
(let ((opoint (point))
;; Markdown or outline link ids are case
;; insensitive and - characters are converted to
@@ -895,7 +895,7 @@ program)."
(case-fold-search t)
(anchor-name (subst-char-in-string ?- ?\ anchor)))
(goto-char (point-min))
- (if (re-search-forward (format
+ (if (re-search-forward (format
(cond ((string-match
hpath:markdown-suffix-regexp buffer-file-name)
hpath:markdown-section-pattern)
((eq major-mode 'texinfo-mode)
@@ -964,8 +964,8 @@ Returns the buffer of displayed file."
(find-file filename))
(defun hpath:find-other-window (filename)
- "Edits file FILENAME, in another window or using an external program.
-May create a new window, or reuse an existing one; see the function
display-buffer.
+ "Edit file FILENAME, in another window or using an external program.
+May create a new window, or reuse an existing one; see the function
`display-buffer'.
See documentation of `hpath:find' for details.
Returns non-nil iff file is displayed within a buffer."
(interactive "FFind file in other window: ")
@@ -974,14 +974,14 @@ Returns non-nil iff file is displayed within a buffer."
;; (hyperb:window-system) function from "hversion.el" must be defined
;; prior to use of this function.
(defun hpath:get-external-display-alist ()
- "Returns an alist of (FILENAME-REGEXP . DISPLAY-PROGRAM-STRING-OR-LIST)
elements for the current window system.
+ "Return an alist of (FILENAME-REGEXP . DISPLAY-PROGRAM-STRING-OR-LIST)
elements for the current window system.
These are used to display matching filenames with external window system
programs, such as a pdf reader. The cdr of each element may be:
a string which must represent either an executable name or a shell command
with an embedded %s for substitution of the current context filename;
a list of executable names \(the first valid one is used);
or a function of one filename argument.
-See also `hpath:internal-display-alist' for internal, window-system
independent display settings."
+See also `hpath:internal-display-alist' for internal, `window-system'
independent display settings."
(cond ((memq window-system '(dps ns))
hpath:external-display-alist-macos)
(hyperb:microsoft-os-p
@@ -991,7 +991,7 @@ See also `hpath:internal-display-alist' for internal,
window-system independent
(cons "next"
hpath:external-display-alist-macos)))))))
(defun hpath:is-p (path &optional type non-exist)
- "Returns PATH if PATH is a Posix or MSWindows path, else nil.
+ "Return PATH if PATH is a Posix or MSWindows path, else nil.
If optional TYPE is the symbol 'file or 'directory, then only that path type
is accepted as a match. The existence of the path is checked only for
locally reachable paths (Info paths are not checked). Single spaces are
@@ -1103,7 +1103,7 @@ Is a no-op if the function `push-tag-mark' is not
available."
(push-tag-mark)))))
(defun hpath:relative-to (path &optional default-dir)
- "Returns PATH relative to optional DEFAULT-DIR or `default-directory'.
+ "Return PATH relative to optional DEFAULT-DIR or `default-directory'.
Returns PATH unchanged when it is not a valid path."
(if (not (and (stringp path) (hpath:is-p path)))
path
@@ -1162,7 +1162,7 @@ in-buffer path will not match."
(list start end)))))
(defun hpath:substitute-value (path)
- "Substitutes matching value for Emacs Lisp variables and environment
variables in PATH and returns PATH."
+ "Substitute matching value for Emacs Lisp variables and environment
variables in PATH and return PATH."
;; Uses free variables `match' and `start' from `hypb:replace-match-string'.
(substitute-in-file-name
(hypb:replace-match-string
@@ -1182,13 +1182,13 @@ in-buffer path will not match."
t)))
(defun hpath:substitute-var (path)
- "Replaces up to one match in PATH with the first variable from
`hpath:variables' whose value contains a string match to PATH.
+ "Replace up to one match in PATH with the first variable from
`hpath:variables' whose value contain a string match to PATH.
After any match, the resulting path will contain a varible reference like
${variable}."
(if (not (and (stringp path) (string-match "/" path) (hpath:is-p path)))
path
(setq path (hpath:symlink-referent path))
(let ((new-path)
- (vars hpath:variables)
+ (vars hpath:variables)
result var val)
(while (and vars (null new-path))
(setq var (car vars) vars (cdr vars))
@@ -1219,7 +1219,7 @@ After any match, the resulting path will contain a
varible reference like ${vari
;; be resolved relative to the `/usr/local' directory.
;;
(defun hpath:symlink-referent (linkname)
- "Returns expanded file or directory referent of LINKNAME.
+ "Return expanded file or directory referent of LINKNAME.
LINKNAME should not end with a directory delimiter.
Returns nil if LINKNAME is not a string.
Returns LINKNAME unchanged if it is not a symbolic link but is a pathname."
@@ -1227,7 +1227,7 @@ Returns LINKNAME unchanged if it is not a symbolic link
but is a pathname."
(or (file-symlink-p linkname) linkname)))
(defun hpath:symlink-expand (referent dirname)
- "Returns expanded file or directory REFERENT relative to DIRNAME."
+ "Return expanded file or directory REFERENT relative to DIRNAME."
(let ((var-link)
(dir dirname))
(while (string-match "\\$(\\([^\)]*\\))" referent)
@@ -1262,7 +1262,7 @@ Returns LINKNAME unchanged if it is not a symbolic link
but is a pathname."
referent)
(defun hpath:validate (path)
- "Returns PATH if PATH is a valid, readable path, else signals error.
+ "Return PATH if PATH is a valid, readable path, else signal error.
Info and remote pathnames are considered readable without any
validation checks.
@@ -1303,7 +1303,7 @@ to it."
(unless (fboundp 'hyperb:substitute-in-file-name)
(progn
-;; Overload `substitute-in-file-name' to eliminate truncation of URL prefixes
+;; Overload `substitute-in-file-name' to eliminate truncation of URL prefixes
;; such as http://.
(unless (fboundp 'hyperb:substitute-in-file-name)
(defalias 'hyperb:substitute-in-file-name
@@ -1397,7 +1397,7 @@ off otherwise."
(defun hpath:url-at-p ()
"Return world-wide-web universal resource locator (url) that point
immediately precedes or nil.
-See the documentation for `hpath:url-regexp' for match-string groupings."
+See the documentation for `hpath:url-regexp' for `match-string' groupings."
(if (or (looking-at hpath:url-regexp) (looking-at hpath:url-regexp2)
(looking-at hpath:url-regexp3))
(save-excursion
@@ -1408,7 +1408,7 @@ See the documentation for `hpath:url-regexp' for
match-string groupings."
(defun hpath:url-p (obj)
"Return t if OBJ is a world-wide-web universal resource locator (url)
string, else nil.
See the documentation for `hpath:url-regexp' for match groupings to
-use with string-match."
+use with `string-match'."
(and (stringp obj)
(or (string-match hpath:string-url-regexp obj)
(string-match hpath:string-url-regexp2 obj)
@@ -1416,7 +1416,7 @@ use with string-match."
t))
(defun hpath:www-at-p (&optional include-start-and-end-p)
- "Returns a world-wide-web link reference that point is within or nil.
+ "Return a world-wide-web link reference that point is within or nil.
With optional INCLUDE-START-AND-END-P non-nil, returns list of:
(link-string begin-position end-position)."
(save-excursion
@@ -1432,7 +1432,7 @@ With optional INCLUDE-START-AND-END-P non-nil, returns
list of:
(point))))))
(defun hpath:www-p (path)
- "Returns PATH iff PATH is a world-wide-web link reference, else nil."
+ "Return PATH iff PATH is a world-wide-web link reference, else nil."
(and (stringp path) (hpath:url-p path) path))
;;; ************************************************************************
@@ -1482,7 +1482,7 @@ Returns \"anonymous\" if no default user is set."
(t "anonymous")))
(defun hpath:delete-trailer (string)
- "Return string minus any trailing .?#!*() or quoting characters."
+ "Return STRING minus any trailing .?#!*() or quoting characters."
(save-match-data
(if (and (stringp string) (> (length string) 0)
(string-match "[.?#!*()`'\"]+\\'" string))
@@ -1537,7 +1537,7 @@ from path or t."
(defun hpath:find-program (filename)
"Return one or a list of shell or Lisp commands to execute to display
FILENAME or nil.
-Return nil if FILENAME is a directory name or an image file that emacs can
display.
+Return nil if FILENAME is a directory name or an image file that Emacs can
display.
See also documentation for the function (hpath:get-external-display-alist) and
the variable
`hpath:internal-display-alist'."
(cond ((and (fboundp 'image-mode)
@@ -1556,10 +1556,10 @@ See also documentation for the function
(hpath:get-external-display-alist) and t
))
(defun hpath:match (filename regexp-alist)
- "If FILENAME matches the car of any element in REGEXP-ALIST, return its cdr.
+ "If FILENAME match the car of any element in REGEXP-ALIST, return its cdr.
REGEXP-ALIST elements must be of the form (<filename-regexp>
. <command-to-display-file>). <command-to-display-file> may be a string
-representing an external window-system command to run or it may be a Lisp
+representing an external `window-system' command to run or it may be a Lisp
function to call with FILENAME as its single argument."
(let ((cmd)
elt)
@@ -1570,7 +1570,7 @@ function to call with FILENAME as its single argument."
cmd))
(defun hpath:substitute-dir (var-name rest-of-path)
- "Returns a dir for VAR-NAME using REST-OF-PATH to find match or triggers an
error when no match.
+ "Return a dir for VAR-NAME using REST-OF-PATH to find match or triggers an
error when no match.
VAR-NAME's value may be a directory or a list of directories. If it is a
list, the first directory prepended to REST-OF-PATH which produces a valid
local pathname is returned."
@@ -1614,7 +1614,7 @@ local pathname is returned."
(t (error "(hpath:substitute-dir): Value of VAR-NAME, \"%s\", must be
a string or list" var-name)))))
(defun hpath:substitute-var-name (var-symbol var-dir-val path)
- "Replaces with VAR-SYMBOL any occurrences of VAR-DIR-VAL in PATH.
+ "Replace with VAR-SYMBOL any occurrences of VAR-DIR-VAL in PATH.
Replacement is done iff VAR-DIR-VAL is an absolute path.
If PATH is modified, returns PATH, otherwise returns nil."
(if (and (stringp var-dir-val) (file-name-absolute-p var-dir-val))
diff --git a/hrmail.el b/hrmail.el
index cfab6d0..d5f8c8c 100644
--- a/hrmail.el
+++ b/hrmail.el
@@ -37,7 +37,7 @@
;;;###autoload
(defun Rmail-init ()
- "Initializes Hyperbole support for Rmail mail reading."
+ "Initialize Hyperbole support for Rmail mail reading."
(interactive)
(setq hmail:composer 'mail-mode
hmail:lister 'rmail-summary-mode
@@ -93,7 +93,7 @@ This includes Hyperbole button data."
(defun Rmail-msg-next () (rmail-next-undeleted-message 1))
(defun Rmail-msg-num ()
- "Returns number of Rmail message that point is within."
+ "Return number of Rmail message that point is within."
(interactive)
(let ((count 0) opoint)
(save-excursion
@@ -108,8 +108,8 @@ This includes Hyperbole button data."
(defun Rmail-msg-prev () (rmail-previous-undeleted-message 1))
(defun Rmail-msg-to-p (mail-msg-id mail-file)
- "Sets current buffer to start of msg with MAIL-MSG-ID in MAIL-FILE.
-Returns t if successful, else nil."
+ "Set current buffer to start of msg with MAIL-MSG-ID in MAIL-FILE.
+Return t if successful, else nil."
(if (not (file-readable-p mail-file))
nil
(let ((buf (get-file-buffer mail-file)))
@@ -142,7 +142,7 @@ Returns t if successful, else nil."
(narrow-to-region start end))))
(defun Rmail-to ()
- "Sets current buffer to a mail reader buffer."
+ "Set current buffer to a mail reader buffer."
(and (eq major-mode 'rmail-summary-mode) (set-buffer rmail-buffer)))
(defalias 'Rmail-Summ-delete 'rmail-summary-delete-forward)
@@ -152,7 +152,7 @@ Returns t if successful, else nil."
(defalias 'Rmail-Summ-goto 'rmail-summary-goto-msg)
(defun Rmail-Summ-to ()
- "Sets current buffer to a mail listing buffer."
+ "Set current buffer to a mail listing buffer."
(and (eq major-mode 'rmail-mode) (set-buffer rmail-summary-buffer)))
(defalias 'Rmail-Summ-undelete-all 'rmail-summary-undelete-many)
@@ -210,7 +210,7 @@ Returns t if successful, else nil."
(let ((subject
(save-excursion
(if (re-search-forward "^Subject:" nil t)
- (progn
+ (progn
;; Try to find subject in msg header.
(re-search-forward "^Subject:" nil t)
(skip-chars-forward " \t")
diff --git a/hsettings.el b/hsettings.el
index 0f4ca10..909b4f2 100644
--- a/hsettings.el
+++ b/hsettings.el
@@ -48,7 +48,7 @@
(not (stringp htz:local)))
(progn
;; Comment out the following `error' line...
- (error "(hsettings.el): Configure the TIMEZONE SETTING section in this
file.")
+ (error "(hsettings.el): Configure the TIMEZONE SETTING section in this
file")
;; ... and uncomment the following line, substituting an appropriate
;; timezone from the list in the variable, `htz:world-timezones'
;; in the file, "htz.el".
@@ -164,7 +164,7 @@ package to display search results."
(user-error "(Hyperbole): Invalid web search service `%s'"
service-name))))
(defcustom inhibit-hyperbole-messaging t
- "*Determines whether Hyperbole supports explicit buttons in mail and news
buffers.
+ "*Determine whether Hyperbole supports explicit buttons in mail and news
buffers.
The default of t means disable such support (work remains to
modernize these features). When t, Hyperbole will not alter
messaging mode hooks nor overload functions from these packages,
@@ -176,7 +176,7 @@ to your personal Emacs initialization file, prior to loading
Hyperbole, and then restart Emacs."
:type 'boolean
:initialize 'custom-initialize-set
- :set (lambda (symbol value)
+ :set (lambda (symbol value)
;; Invert value to produce ARG for hyperbole-toggle-messaging.
(hyperbole-toggle-messaging (if value 0 1)))
:group 'hyperbole-buttons)
diff --git a/hsmail.el b/hsmail.el
index 0bc6e76..bdc48dd 100644
--- a/hsmail.el
+++ b/hsmail.el
@@ -32,9 +32,9 @@ for a comment.")
(or (if (listp send-mail-function)
(unless (equal (nth 2 send-mail-function) '(smail:widen))
(error
- "(hsmail): Set 'send-mail-function' to a symbol-name, not a
list, before load.")))
+ "(hsmail): Set 'send-mail-function' to a symbol-name, not a
list, before load")))
(setq send-mail-function `(lambda () (smail:widen)
(,send-mail-function))))
- (error "(hsmail): Install an Emacs \"sendmail.el\" which includes
'send-mail-function'."))
+ (error "(hsmail): Install an Emacs \"sendmail.el\" which includes
'send-mail-function'"))
(if (fboundp 'mail-prefix-region)
;;
@@ -76,7 +76,7 @@ Used by `mail-yank-original' via `mail-indent-citation'.")
;;; ************************************************************************
(defun smail:comment-add (&optional comment-form)
- "Adds a comment to the current outgoing message if Hyperbole has been loaded
and `inhibit-hyperbole-messaging' is nil.
+ "Add a comment to the current outgoing message if Hyperbole has been loaded
and `inhibit-hyperbole-messaging' is nil.
Optional COMMENT-FORM is evaluated to obtain the string to add to the
message. If not given, 'smail:comment' is evaluated by default."
(if (and (featurep 'hyperbole) (not inhibit-hyperbole-messaging))
diff --git a/hsys-org.el b/hsys-org.el
index 7c916e1..f5be91b 100644
--- a/hsys-org.el
+++ b/hsys-org.el
@@ -33,20 +33,20 @@
"*Boolean function of no arguments that determines whether hsys-org actions
are triggered or not.")
(defun hsys-org-mode-p ()
- "Returns non-nil if an Org-related major or minor mode is active in the
current buffer."
+ "Return non-nil if an Org-related major or minor mode is active in the
current buffer."
(or (derived-mode-p 'org-mode)
(and (boundp 'outshine-mode) outshine-mode)
(and (boundp 'poporg-mode) poporg-mode)))
(defun hsys-org-cycle ()
- "Calls org-cycle and forces it to be set as this-command to cycle through
all states."
+ "Call `org-cycle' and force it to be set as `this-command' to cycle through
all states."
(setq last-command 'org-cycle
this-command 'org-cycle)
(org-cycle))
(defun hsys-org-global-cycle ()
- "Calls org-global-cycle and forces it to be set as this-command to cycle
through all states."
+ "Call `org-global-cycle' and force it to be set as `this-command' to cycle
through all states."
(setq last-command 'org-cycle
this-command 'org-cycle)
(org-global-cycle nil))
@@ -127,7 +127,7 @@ If LINK-TARGET is nil, follows any link target at point.
Otherwise, triggers an
(defact org-radio-target (&optional target)
- "Jumps to the next occurrence of an optional Org mode radio TARGET link.
+ "Jump to the next occurrence of an optional Org mode radio TARGET link.
If TARGET is nil and point is on a radio target definition or link, it
uses that one. Otherwise, triggers an error."
(let (start-end)
@@ -146,7 +146,7 @@ uses that one. Otherwise, triggers an error."
;;; ************************************************************************
(defun hsys-org-region-with-text-property-value (pos property)
- "Returns (start . end) buffer positions of the region around POS that shares
its non-nil text PROPERTY value, else nil."
+ "Return (start . end) buffer positions of the region around POS that shares
its non-nil text PROPERTY value, else nil."
(if (null pos) (setq pos (point)))
(let ((property-value (get-text-property pos property))
(start-point pos))
@@ -160,32 +160,32 @@ uses that one. Otherwise, triggers an error."
(cons start-point (next-single-property-change start-point property)))))
(defun hsys-org-at-block-start-p ()
- "Returns 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,
else nil."
(save-excursion
(forward-line 0)
(or (looking-at org-block-regexp)
(looking-at org-dblock-start-re))))
(defun hsys-org-link-at-p ()
- "Returns non-nil iff point is on an Org mode link.
-Assumes caller has already checked that the current buffer is in org-mode."
+ "Return non-nil iff point is on an Org mode link.
+Assumes caller has already checked that the current buffer is in `org-mode'."
(or (org-in-regexp org-any-link-re)
(hsys-org-face-at-p 'org-link)))
;; Assumes caller has already checked that the current buffer is in org-mode.
(defun hsys-org-target-at-p ()
- "Returns non-nil iff point is on an Org mode radio target (definition) or
link target (referent).
-Assumes caller has already checked that the current buffer is in org-mode."
+ "Return non-nil iff point is on an Org mode radio target (definition) or
link target (referent).
+Assumes caller has already checked that the current buffer is in `org-mode'."
(hsys-org-face-at-p 'org-target))
(defun hsys-org-radio-target-link-at-p ()
- "Returns (target-start . target-end) positions iff point is on an Org mode
radio target link (referent), else nil."
+ "Return (target-start . target-end) positions iff point is on an Org mode
radio target link (referent), else nil."
(and (get-text-property (point) 'org-linked-text)
(hsys-org-link-at-p)
(hsys-org-region-with-text-property-value (point) 'org-linked-text)))
(defun hsys-org-radio-target-def-at-p ()
- "Returns (target-start . target-end) positions iff point is on an Org mode
radio target (definition), including any delimiter characters, else nil."
+ "Return (target-start . target-end) positions iff point is on an Org mode
radio target (definition), including any delimiter characters, else nil."
(when (hsys-org-target-at-p)
(save-excursion
(if (not (looking-at "<<<"))
@@ -196,12 +196,12 @@ Assumes caller has already checked that the current
buffer is in org-mode."
(hsys-org-region-with-text-property-value (point) 'face)))))
(defun hsys-org-radio-target-at-p ()
- "Returns (target-start . target-end) positions iff point is on an Org mode
<<<radio target definition>>> or radio target link (referent), including any
delimiter characters, else nil."
+ "Return (target-start . target-end) positions iff point is on an Org mode
<<<radio target definition>>> or radio target link (referent), including any
delimiter characters, else nil."
(or (hsys-org-radio-target-def-at-p)
(hsys-org-radio-target-link-at-p)))
(defun hsys-org-internal-link-target-at-p ()
- "Returns (target-start . target-end) positions iff point is on an Org mode
<<link target>>, including any delimiter characters, else nil."
+ "Return (target-start . target-end) positions iff point is on an Org mode
<<link target>>, including any delimiter characters, else nil."
(when (hsys-org-target-at-p)
(save-excursion
(if (not (looking-at "<<"))
@@ -212,14 +212,14 @@ Assumes caller has already checked that the current
buffer is in org-mode."
(hsys-org-region-with-text-property-value (point) 'face)))))
(defun hsys-org-face-at-p (org-face-type)
- "Returns `org-face-type` iff point is on a character with face
`org-face-type', a symbol, else nil."
+ "Return ORG-FACE-TYPE iff point is on a character with face ORG-FACE-TYPE, a
symbol, else nil."
(let ((face-prop (get-text-property (point) 'face)))
(when (or (eq face-prop org-face-type)
(and (listp face-prop) (memq org-face-type face-prop)))
org-face-type)))
(defun hsys-org-search-internal-link-p (target)
- "Searches from buffer start for an Org internal link definition matching
TARGET.
+ "Search from buffer start for an Org internal link definition matching
TARGET.
White spaces are insignificant. Returns t if a link is found, else nil."
(if (string-match "<<.+>>" target)
(setq target (substring target 2 -2)))
@@ -240,7 +240,7 @@ White spaces are insignificant. Returns t if a link is
found, else nil."
nil)))
(defun hsys-org-search-radio-target-link-p (target)
- "Searches from point for a radio target link matching TARGET.
+ "Search from point for a radio target link matching TARGET.
White spaces are insignificant. Returns t if a target link is found, else
nil."
(if (string-match "<<<.+>>>" target)
(setq target (substring target 3 -3)))
@@ -269,7 +269,7 @@ White spaces are insignificant. Returns t if a target link
is found, else nil."
(defun hsys-org-to-next-radio-target-link (target)
- "Moves to the start of the next radio TARGET link if found. TARGET must be
a string."
+ "Move to the start of the next radio TARGET link if found. TARGET must be a
string."
(if (string-match "<<<.+>>>" target)
(setq target (substring target 3 -3)))
(let ((opoint (point))
diff --git a/hsys-www.el b/hsys-www.el
index 663a7c1..015c8e8 100644
--- a/hsys-www.el
+++ b/hsys-www.el
@@ -131,7 +131,7 @@ is used. Valid values of this variable include
`browse-url-default-browser' and
(let* ((remote-sym (hpath:remote-available-p))
(inhibit-file-name-handlers
(if remote-sym
- (append (list 'dired-handler-fn
+ (append (list 'dired-handler-fn
(intern-soft (concat (symbol-name remote-sym)
"-file-handler-function")))
(and (eq inhibit-file-name-operation 'find-file-noselect)
diff --git a/htz.el b/htz.el
index 6ff6713..598e399 100644
--- a/htz.el
+++ b/htz.el
@@ -65,13 +65,13 @@ If a two-digit year, the first two digits of the current
year are prepended.
Timezone in DATE is optional, it defaults to the value of `htz:local'.
Recognizes the following styles:
- (1) \"(1 30 1999)\" or \"(1 30 1999)\" `calendar-julian-date' requires
`parsed-current-date' arg
+ (1) \"(1 30 1999)\" or \"(1 30 1999)\" `calendar-julian-date' requires
PARSED-CURRENT-DATE arg
(2) \"14 Apr 89 03:20[:12] [GMT]\"
(3) \"Fri, 17 Mar [19]89 4:01[:33] [GMT]\"
(4) \"Mon Jan 16 16:12[:37] [GMT] 1989\"
(5) \"19911014:07:51:08 or 1991101407:51:08\" `sortable date'
- (6) \"Mar 29 14:00\" `ls -l date' requires `parsed-current-date' arg
- (7) \"Mar 7 1994\" `ls -l date' requires `parsed-current-date' arg"
+ (6) \"Mar 29 14:00\" `ls -l date' requires PARSED-CURRENT-DATE arg
+ (7) \"Mar 7 1994\" `ls -l date' requires PARSED-CURRENT-DATE arg"
(let ((date (or date ""))
year month day time
zone) ; This may be nil.
@@ -291,7 +291,7 @@ Optional argument TIMEZONE specifies a time zone."
(aref [31 28 31 30 31 30 31 31 30 31 30 31] (1- month))))
(defun htz:leap-year-p (year)
- "Returns t if YEAR is a Gregorian leap year."
+ "Return t if YEAR is a Gregorian leap year."
(or (and (zerop (% year 4))
(not (zerop (% year 100))))
(zerop (% year 400))))
@@ -353,7 +353,7 @@ Optional argument TIMEZONE specifies a time zone."
(let ((local-tz (or (getenv "TZ") (getenv "TIMEZONE")
(if (fboundp 'current-time-zone)
(car (cdr (current-time-zone))))
- (progn
+ (progn
(require 'hypb)
(hypb:call-process-p
"date" nil '(if (re-search-backward
diff --git a/hui-em-but.el b/hui-em-but.el
index 9292230..fefb991 100644
--- a/hui-em-but.el
+++ b/hui-em-but.el
@@ -28,7 +28,7 @@
(require 'hbut)
(defun hproperty:background ()
- "Returns default background color for current frame."
+ "Return default background color for current frame."
(or (face-background (defface default nil
"Standard text face."
:group 'hyperbole-buttons))
@@ -36,7 +36,7 @@
"White"))
(defun hproperty:foreground ()
- "Returns default foreground color for current frame."
+ "Return default foreground color for current frame."
(or (face-foreground (defface default nil
"Standard text face."
:group 'hyperbole-buttons))
@@ -309,7 +309,7 @@ highlighted."
;;; ************************************************************************
(defun hproperty:cycle-but-color (&optional color)
- "Switches button color to optional COLOR name or next item referenced by
hproperty:color-ptr."
+ "Switch button color to optional COLOR name or next item referenced by
hproperty:color-ptr."
(interactive "sHyperbole button color: ")
(if (not (display-color-p))
nil
@@ -365,7 +365,7 @@ highlighted."
(make-local-variable 'hproperty:item-face)
(if (stringp background) (setq hproperty:item-highlight-color background))
(if (not hproperty:highlight-face)
- (progn
+ (progn
(setq hproperty:highlight-face
(defface hproperty:highlight-face nil
"Item highlighting face. Use (hproperty:set-item-highlight) to set."
diff --git a/hui-jmenu.el b/hui-jmenu.el
index 59b4861..b8466d56 100644
--- a/hui-jmenu.el
+++ b/hui-jmenu.el
@@ -196,7 +196,7 @@
(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."
+ "Reverse sort and return list of (`buffer-name' . `mode-name') elements by
`mode-name' and then by `buffer-name'."
(let ((buf (get-buffer-create " tmp-sort")))
(with-current-buffer buf
(setq buffer-read-only nil)
@@ -264,7 +264,7 @@ With optional prefix arg INSERT-FLAG, inserts the pathname
at point."
nil))
(defun hui-menu-window-list-all-frames (&optional mini)
- "Returns a list of Lisp window objects for all Emacs windows in all frames.
+ "Return a list of Lisp window objects for all Emacs windows in all frames.
Optional first arg MINI t means include the minibuffer window in the list,
even if it is not active. If MINI is neither t nor nil it means to not count
the minibuffer window even if it is active."
@@ -331,7 +331,7 @@ frame. The current buffer is buried in the old frame's
buffer list."
"Last set of buffer and mode names used in hui-menu-of-buffers or nil.")
(defvar hui-menu-of-buffers-cache nil
- "Last menu of mode-name ordered buffers from hui-menu-of-buffers or nil.")
+ "Last menu of `mode-name' ordered buffers from hui-menu-of-buffers or nil.")
;;; ************************************************************************
;;; Public variables
diff --git a/hui-menu.el b/hui-menu.el
index d8335fb..1a0cdd3 100644
--- a/hui-menu.el
+++ b/hui-menu.el
@@ -83,7 +83,7 @@
(append
'("----"
["Alphabetize-List"
- (setq hui-menu-order-explicit-buttons
+ (setq hui-menu-order-explicit-buttons
(not hui-menu-order-explicit-buttons))
:style toggle :selected
hui-menu-order-explicit-buttons]
"Activate:")
@@ -362,7 +362,7 @@ REBUILD-FLAG is non-nil, in which case the menu is rebuilt."
["Create" hui:ebut-create t]
["Delete" hui:ebut-delete t]
["Edit" hui:ebut-modify t]
- ("Help"
+ ("Help"
["Manual" (id-info "(hyperbole)Location") t]
"----"
["Buffer-Buttons" (hui:hbut-report -1) t]
diff --git a/hui-mini.el b/hui-mini.el
index 6d350bc..a24b9eb 100644
--- a/hui-mini.el
+++ b/hui-mini.el
@@ -77,7 +77,7 @@ documentation, not the full text."
(setq hui:menu-p nil))))
(defun hui:menu-act (menu &optional menu-list doc-flag help-string-flag)
- "Prompts user with Hyperbole MENU (a symbol) and performs selected item.
+ "Prompt user with Hyperbole MENU (a symbol) and perform selected item.
Optional second argument MENU-LIST is a Hyperbole menu list structure from
which to extract MENU. It defaults to `hui:menus'. See its definition for
the menu list structure.
@@ -132,7 +132,7 @@ documentation, not the full text."
(hui:menu-backward-item)))
(defun hui:menu-doc (key-sequence &optional help-string-flag)
- "Returns formatted documentation for a normalized Hyperbole minibuffer menu
KEY-SEQUENCE.
+ "Return formatted documentation for a normalized Hyperbole minibuffer menu
KEY-SEQUENCE.
With optional HELP-STRING-FLAG, instead returns the one line help string for
the key sequence."
(when (and (stringp key-sequence)
(not (eq key-sequence ""))
@@ -147,7 +147,7 @@ With optional HELP-STRING-FLAG, instead returns the one
line help string for the
(discard-input)))))
(defun hui:menu-enter (&optional char-str)
- "Uses CHAR-STR or last input character as minibuffer argument."
+ "Use CHAR-STR or last input character as minibuffer argument."
(interactive)
(let ((input (or char-str (aref (recent-keys) (1- (length (recent-keys)))))))
(and (not (integerp input))
@@ -273,7 +273,7 @@ documentation, not the full text."
(nth (- (length winds) (length (memq bot bot-list))) winds))))
(defun hui:menu-item (key doc-flag help-string-flag &optional menu menu-alist)
-"Returns either the action or the documentation for a Hyperbole minibuffer
menu item KEY.
+"Return either the action or the documentation for a Hyperbole minibuffer menu
item KEY.
If DOC-FLAG is non-nil, returns the fully formatted documentation unless
HELP-STRING-FLAG is non-nil, in which case only the first line of
documentation is returned. If both are nil, the action form for the
@@ -281,7 +281,7 @@ item is returned.
Two additional optional arguments determine the items from which key
selects, MENU and MENU-ALIST are Hyperbole minibuffer menu internal
-constructs. If not given, the top-level Hyperbole menu is used."
+constructs. If not given, the top level Hyperbole menu is used."
(unless menu-alist
(setq menu-alist (or (cdr (assq (or (and (symbolp menu) menu) 'hyperbole)
hui:menus))
@@ -313,7 +313,7 @@ constructs. If not given, the top-level Hyperbole menu is
used."
act-form)))))
(defun hui:menu-line (menu-alist)
- "Returns a menu line string built from MENU-ALIST."
+ "Return a menu line string built from MENU-ALIST."
(let ((menu-prompt (concat (car (car menu-alist)) " "))
(menu-items (mapconcat 'car (cdr menu-alist) " "))
menu-line)
@@ -373,7 +373,7 @@ constructs. If not given, the top-level Hyperbole menu is
used."
;;; ************************************************************************
(defun hyperbole-minibuffer-menu ()
- "Rebuilds and returns the entire Hyperbole minibuffer menu structure."
+ "Rebuild and return the entire Hyperbole minibuffer menu structure."
(setq
hui:menus
(delq nil
diff --git a/hui-mouse.el b/hui-mouse.el
index d3396b2..9efe569 100644
--- a/hui-mouse.el
+++ b/hui-mouse.el
@@ -51,9 +51,9 @@
"*Command that sets point to the mouse cursor position.")
(defun action-key-error ()
- (hypb:error "(Hyperbole Action Key): No action defined for this context; try
another location."))
+ (hypb:error "(Hyperbole Action Key): No action defined for this context; try
another location"))
(defun assist-key-error ()
- (hypb:error "(Hyperbole Assist Key): No action defined for this context; try
another location."))
+ (hypb:error "(Hyperbole Assist Key): No action defined for this context; try
another location"))
(defcustom action-key-default-function #'action-key-error
"*Function run by the Action Key in an unspecified context.
@@ -101,7 +101,7 @@ Its default value is #'smart-scroll-down."
((smart-company-to-definition) . (smart-company-help)))
;;
;; Treemacs hierarchical file manager
- ((eq major-mode 'treemacs-mode) .
+ ((eq major-mode 'treemacs-mode) .
((smart-treemacs) . (smart-treemacs)))
;;
;; Handle Emacs push buttons in buffers
@@ -155,10 +155,10 @@ Its default value is #'smart-scroll-down."
;; It is not included with Hyperbole.
;;
;; This selects or gives help for a menu item.
- ((eq major-mode 'smart-menu-mode) .
+ ((eq major-mode 'smart-menu-mode) .
((smart-menu-select) . (smart-menu-help)))
;;
- ((derived-mode-p 'dired-mode) .
+ ((derived-mode-p 'dired-mode) .
((smart-dired) . (smart-dired-assist)))
;;
;; If on a Hyperbole button, perform action or give help.
@@ -224,7 +224,7 @@ Its default value is #'smart-scroll-down."
((hui-select-mark-delimited-sexp) .
(progn (hui-select-mark-delimited-sexp) (hmouse-kill-region))))
;;
- ((eq major-mode 'kotl-mode) .
+ ((eq major-mode 'kotl-mode) .
((kotl-mode:action-key) . (kotl-mode:assist-key)))
;;
;; Rdb-mode supports direct selection and viewing of in-memory relational
@@ -340,14 +340,14 @@ Its default value is #'smart-scroll-down."
((eq major-mode 'ibuffer-mode) .
((smart-ibuffer-menu) . (smart-ibuffer-menu-assist)))
;;
- ((eq major-mode 'tar-mode) .
+ ((eq major-mode 'tar-mode) .
((smart-tar) . (smart-tar-assist)))
;;
;; Follow references in man pages.
((setq hkey-value (smart-man-entry-ref)) .
((smart-man-display hkey-value) . (smart-man-display hkey-value)))
;;
- ((eq major-mode 'w3-mode) .
+ ((eq major-mode 'w3-mode) .
((w3-follow-link) . (w3-goto-last-buffer)))
;;
((and (boundp 'hyrolo-display-buffer) (equal (buffer-name)
hyrolo-display-buffer)) .
@@ -357,7 +357,7 @@ Its default value is #'smart-scroll-down."
((smart-image-dired-thumbnail) . (smart-image-dired-thumbnail-assist)))
;;
;; Gomoku game
- ((eq major-mode 'gomoku-mode) .
+ ((eq major-mode 'gomoku-mode) .
((gomoku-human-plays) . (gomoku-human-takes-back)))
;;
;; Support the OO-Browser when available. It is a separate Emacs
@@ -419,20 +419,20 @@ smart keyboard keys.")
;;; ************************************************************************
(defun first-line-p ()
- "Returns true if point is on the first line of the buffer."
+ "Return true if point is on the first line of the buffer."
(save-excursion (beginning-of-line) (bobp)))
(defun last-line-p ()
- "Returns true if point is on the last line of the buffer."
+ "Return true if point is on the last line of the buffer."
(save-excursion (end-of-line) (eobp)))
(defun smart-completion-help ()
- "Offers completion help for current minibuffer argument, if any."
+ "Offer completion help for current minibuffer argument, if any."
(if (where-is-internal 'minibuffer-completion-help (current-local-map))
(minibuffer-completion-help)))
(defun smart-symlink-expand (path)
- "Returns referent for possible symbolic link, PATH."
+ "Return referent for possible symbolic link, PATH."
(if (not (fboundp 'symlink-referent))
path
(let ((start 0) (len (length path)) (ref) (part))
@@ -459,9 +459,9 @@ If buffer menu items are marked, return nil, else t."
t)))
(defun smart-buffer-menu ()
- "Uses a single key or mouse key to manipulate buffer-menu entries.
+ "Use a single key or mouse key to manipulate `buffer-menu' entries.
-Invoked via a key press when in Buffer-menu-mode. It assumes that its
+Invoked via a key press when in `Buffer-menu-mode. It assumes that its
caller has already checked that the key was pressed in an appropriate buffer
and has moved the cursor there.
@@ -488,9 +488,9 @@ If key is pressed:
(t (Buffer-menu-select))))
(defun smart-buffer-menu-assist ()
- "Uses a single assist-key or mouse assist-key to manipulate buffer-menu
entries.
+ "Use a single assist-key or mouse assist-key to manipulate `buffer-menu'
entries.
-Invoked via an assist-key press when in Buffer-menu-mode. It assumes that its
+Invoked via an assist-key press when in `Buffer-menu-mode'. It assumes that
its
caller has already checked that the assist-key was pressed in an appropriate
buffer and has moved the cursor there.
@@ -528,7 +528,7 @@ If buffer menu items are marked, return nil, else t."
t)))
(defun smart-ibuffer-menu ()
- "Uses a single key or mouse key to manipulate ibuffer entries.
+ "Use a single key or mouse key to manipulate ibuffer entries.
Invoked via a key press when in ibuffer-mode. It assumes that
its caller has already checked that the key was pressed in an
@@ -550,12 +550,12 @@ If key is pressed:
(goto-char (1- (point)))
(bolp)))
(ibuffer-mark-forward nil nil 1))
- ((br-in-browser) (br-buffer-menu-select))
+ ((br-in-browser) (br-buffer-menu-select))
((smart-ibuffer-menu-no-marks))
(t (ibuffer-do-view))))
(defun smart-ibuffer-menu-assist ()
- "Uses a single assist-key or mouse assist-key to manipulate buffer-menu
entries.
+ "Use a single assist-key or mouse assist-key to manipulate `buffer-menu'
entries.
Invoked via an assist-key press when in ibuffer-mode. It assumes that
its caller has already checked that the assist-key was pressed in an
@@ -585,7 +585,7 @@ If assist-key is pressed:
;;; ************************************************************************
(defun smart-calendar ()
- "Uses a single key or mouse key to manipulate the scrolling calendar.
+ "Use a single key or mouse key to manipulate the scrolling calendar.
Invoked via a key press when in calendar-mode. It assumes that its
caller has already checked that the key was pressed in an appropriate buffer
@@ -606,7 +606,7 @@ If key is pressed:
(diary-view-entries 1))))
(defun smart-calendar-assist ()
- "Uses a single assist-key or mouse assist-key to manipulate the scrolling
calendar.
+ "Use a single assist-key or mouse assist-key to manipulate the scrolling
calendar.
Invoked via an assist-key press when in calendar-mode. It assumes that its
caller has already checked that the assist-key was pressed in an appropriate
@@ -672,9 +672,9 @@ Use for direct selection of an ancestor directory of this
directory."
default-directory))
(defun smart-dired ()
- "Uses a single key or mouse key to manipulate directory entries.
+ "Use a single key or mouse key to manipulate directory entries.
-Invoked via a key press when in dired-mode. It assumes that its
+Invoked via a key press when in `dired-mode'. It assumes that its
caller has already checked that the key was pressed in an appropriate buffer
and has moved the cursor there.
@@ -711,15 +711,15 @@ If key is pressed:
(dired-do-flagged-delete))
((fboundp 'dired-do-deletions)
(dired-do-deletions))
- (t (error "(smart-dired): No Dired expunge function.")))))
+ (t (error "(smart-dired): No Dired expunge function")))))
(t (hpath:find (smart-dired-pathname-up-to-point)))))
((last-line-p) (quit-window))
(t (hpath:find (dired-get-filename)))))
(defun smart-dired-assist ()
- "Uses a single assist-key or mouse assist-key to manipulate directory
entries.
+ "Use a single assist-key or mouse assist-key to manipulate directory entries.
-Invoked via an assist-key press when in dired-mode. It assumes that its
+Invoked via an assist-key press when in `dired-mode'. It assumes that its
caller has already checked that the assist-key was pressed in an appropriate
buffer and has moved the cursor there.
@@ -739,7 +739,7 @@ If assist-key is pressed:
(goto-char (point-max)))
((looking-at "~") (dired-flag-backup-files))
((looking-at "#") (dired-flag-auto-save-files))
- (t
+ (t
;; Prevent any region selection from causing multiple files
;; to be marked for deletion; we want to mark only one.
(deactivate-mark t)
@@ -752,7 +752,7 @@ If assist-key is pressed:
;;; ************************************************************************
(defun smart-gnus-group ()
- "Uses a key or mouse key to move through Gnus Newsgroup listings.
+ "Use a key or mouse key to move through Gnus Newsgroup listings.
Invoked via a key press when in gnus-group-mode. It assumes that its caller
has already checked that the key was pressed in an appropriate buffer and has
moved the cursor to the selected buffer.
@@ -774,7 +774,7 @@ If key is pressed within:
(t (gnus-group-read-group nil))))
(defun smart-gnus-group-assist ()
- "Uses an assist-key or assist-mouse key to move through Gnus Newsgroup
listings.
+ "Use an assist-key or assist-mouse key to move through Gnus Newsgroup
listings.
Invoked via an assist-key press when in gnus-group-mode. It assumes that its
caller has already checked that the key was pressed in an appropriate buffer
and has moved the cursor to the selected buffer.
@@ -796,7 +796,7 @@ If key is pressed within:
(t (gnus-group-read-group nil))))
(defun smart-gnus-summary ()
- "Uses a key or mouse key to move through Gnus News article listings.
+ "Use a key or mouse key to move through Gnus News article listings.
Invoked via a key press when in gnus-summary-mode. It assumes that its caller
has already checked that the key was pressed in an appropriate buffer and has
moved the cursor to the selected buffer.
@@ -826,7 +826,7 @@ If key is pressed within:
(call-interactively 'gnus-summary-next-page))))
(defun smart-gnus-summary-assist ()
- "Uses an assist-key or assist-mouse key to move through Gnus News articles.
+ "Use an assist-key or assist-mouse key to move through Gnus News articles.
Invoked via an assist-key press when in gnus-summary-mode. It assumes that its
caller has already checked that the key was pressed in an appropriate buffer
and has moved the cursor to the selected buffer.
@@ -848,7 +848,7 @@ If key is pressed within:
(call-interactively 'gnus-summary-prev-page))))
(defun smart-gnus-article ()
- "Uses a key or mouse key to move through Gnus netnews articles.
+ "Use a key or mouse key to move through Gnus netnews articles.
Invoked via a key press when in gnus-article-mode.
It assumes that its caller has already checked that the key was pressed in an
@@ -872,7 +872,7 @@ If key is pressed within:
(t (smart-scroll-up))))
(defun smart-gnus-article-assist ()
- "Uses an assist-key or mouse assist-key to move through Gnus netnews
articles.
+ "Use an assist-key or mouse assist-key to move through Gnus netnews articles.
Invoked via an assist-key press when in gnus-article-mode.
It assumes that its caller has already checked that the assist-key was pressed
in
@@ -900,14 +900,14 @@ If assist-key is pressed within:
;;; ************************************************************************
(defun smart-helm-at-header ()
- "Returns t iff Action Key depress was on the first fixed header line or a
helm section header of the current buffer."
+ "Return t iff Action Key depress was on the first fixed header line or a
helm section header of the current buffer."
(or (helm-pos-header-line-p)
(and (eventp action-key-depress-args)
(eq (posn-area (event-start action-key-depress-args))
'header-line))))
(defun smart-helm-line-has-action ()
- "Marks and returns the actions for the helm selection item at the point of
Action Key depress, or nil if line lacks any action.
+ "Mark and return the actions for the helm selection item at the point of
Action Key depress, or nil if line lacks any action.
Assumes Hyperbole has already checked that helm is active."
(let ((helm-buffer (if (equal helm-action-buffer (buffer-name)) helm-buffer
(buffer-name))))
(save-excursion
@@ -940,7 +940,7 @@ Assumes Hyperbole has already checked that helm is active."
(sit-for 0.2)))
(defun smart-helm-at (depress-event)
- "Returns non-nil iff Smart Mouse DEPRESS-EVENT was on a helm section header,
candidate separator or at eob or eol.
+ "Return non-nil iff Smart Mouse DEPRESS-EVENT was on a helm section header,
candidate separator or at eob or eol.
If non-nil, returns a property list of the form: (section-header <bool>
separator <bool> eob <bool> or eol <bool>).
If a section-header or separator, selects the first following candidate line.
Assumes Hyperbole has already checked that helm is active."
@@ -968,19 +968,19 @@ Assumes Hyperbole has already checked that helm is
active."
nil))))))
(defun smart-helm-to-minibuffer ()
- "Selects minibuffer window when it is active."
+ "Select minibuffer window when it is active."
(if (> (minibuffer-depth) 0)
(select-window (minibuffer-window))))
(defun smart-helm()
- "Executes helm actions based on Action Key click locations:
- At the end of the buffer, quits from helm and exits the minibuffer.
- On a candidate line, performs the candidate's first action and remains in
the minibuffer;
- On the top, fixed header line, toggles display of the selected candidate's
possible actions;
- On an action list line, performs the action after exiting the minibuffer;
- On a source section header, moves to the next source section or first if on
last.
- On a candidate separator line, does nothing.
- In the minibuffer window, ends the helm session and performs the selected
item's action."
+ "Execute helm actions based on Action Key click locations:
+At the end of the buffer, quits from helm and exits the minibuffer.
+On a candidate line, performs the candidate's first action and remains in the
minibuffer;
+On the top, fixed header line, toggles display of the selected candidate's
possible actions;
+On an action list line, performs the action after exiting the minibuffer;
+On a source section header, moves to the next source section or first if on
last.
+On a candidate separator line, does nothing.
+In the minibuffer window, ends the helm session and performs the selected
item's action."
(unless (hmouse-check-action-key)
(error "(smart-helm): Hyperbole Action Mouse Key - either depress or
release event is improperly configured"))
(let* ((non-text-area-p (and (eventp action-key-depress-args)
@@ -1019,14 +1019,14 @@ Assumes Hyperbole has already checked that helm is
active."
(call-interactively binding))))))
(defun smart-helm-assist()
- "Executes helm actions based on Assist Key click locations:
- At the end of the buffer, quits from helm and exits the minibuffer.
- On a candidate line, display's the candidate's first action and remains in
the minibuffer;
- On the top, fixed header line, toggles display of the selected candidate's
possible actions;
- On an action list line, performs the action after exiting the minibuffer;
- On a source section header, moves to the previous source section or last if
on first.
- On a candidate separator line, does nothing.
- In the minibuffer window, ends the helm session and performs the selected
item's action."
+ "Execute helm actions based on Assist Key click locations:
+At the end of the buffer, quits from helm and exits the minibuffer.
+On a candidate line, display's the candidate's first action and remains in the
minibuffer;
+On the top, fixed header line, toggles display of the selected candidate's
possible actions;
+On an action list line, performs the action after exiting the minibuffer;
+On a source section header, moves to the previous source section or last if on
first.
+On a candidate separator line, does nothing.
+In the minibuffer window, ends the helm session and performs the selected
item's action."
;; Hyperbole has checked that this line has an action prior to
;; invoking this function.
(unless (hmouse-check-assist-key)
@@ -1078,7 +1078,7 @@ Assumes Hyperbole has already checked that helm is
active."
;;; ************************************************************************
(defun smart-hmail ()
- "Uses a key or mouse key to move through e-mail messages and summaries.
+ "Use a key or mouse key to move through e-mail messages and summaries.
Invoked via a key press when in hmail:reader or hmail:lister mode.
It assumes that its caller has already checked that the key was pressed in an
@@ -1111,7 +1111,7 @@ If key is pressed within:
(t (lmail:goto))))
(defun smart-hmail-assist ()
- "Uses an assist key or mouse key to move through e-mail messages and
summaries.
+ "Use an assist key or mouse key to move through e-mail messages and
summaries.
Invoked via an assist key press when in hmail:reader or hmail:lister mode.
It assumes that its caller has already checked that the assist-key was pressed
in
@@ -1164,12 +1164,12 @@ buffer and has moved the cursor to the selected buffer."
;;; ************************************************************************
(defun smart-image-dired-thumbnail ()
- "Selects thumbnail and scales its image for display in another Emacs window."
+ "Select thumbnail and scale its image for display in another Emacs window."
(image-dired-mouse-select-thumbnail action-key-release-args)
(image-dired-display-thumbnail-original-image))
(defun smart-image-dired-thumbnail-assist ()
- "Selects thumbnail and uses the external viewer named by
`image-dired-external-viewer' to display it."
+ "Select thumbnail and use the external viewer named by
`image-dired-external-viewer' to display it."
(image-dired-mouse-select-thumbnail assist-key-release-args)
(image-dired-thumbnail-display-external))
@@ -1184,7 +1184,7 @@ Uses the imenu library and the value of
`hpath:display-where' to display."
(funcall imenu-default-goto-function item-name item-pos))
(defun smart-imenu-item-at-p (&optional variable-flag)
- "If any identifier at point is in the current buffer's imenu, returns its
marker position, else nil.
+ "If any identifier at point is in the current buffer's imenu, return its
marker position, else nil.
With optional VARIABLE-FLAG non-nil, matches to variable definitions only.
Does nothing unless imenu has been loaded and an index has been
@@ -1201,7 +1201,7 @@ sets `hkey-value' to (identifier .
identifier-definition-buffer-position)."
;; Derived from `imenu' function in the imenu library.
(defun smart-imenu-item-p (index-item &optional variable-flag)
- "If INDEX-ITEM is in the current buffer's imenu, returns its definition
marker position, else nil.
+ "If INDEX-ITEM is in the current buffer's imenu, return its definition
marker position, else nil.
If INDEX-ITEM is both a function and a variable, the function
definition is used by default; in such a case, when optional
VARIABLE-FLAG is non-nil, the variable definition is used instead."
@@ -1238,7 +1238,7 @@ VARIABLE-FLAG is non-nil, the variable definition is used
instead."
;;
(defun smart-apropos ()
- "Moves through UNIX man apropos listings by using one key or mouse key.
+ "Move through UNIX man apropos listings by using one key or mouse key.
Invoked via a key press when in unix-apropos-mode. It assumes that
its caller has already checked that the key was pressed in an appropriate
@@ -1256,7 +1256,7 @@ If key is pressed:
(unix-apropos-get-man)))
(defun smart-apropos-assist ()
- "Moves through UNIX man apropos listings by using one assist-key or mouse
assist-key.
+ "Move through UNIX man apropos listings by using one assist-key or mouse
assist-key.
Invoked via an assist-key press when in unix-apropos-mode. It assumes that
its caller has already checked that the assist-key was pressed in an
appropriate
@@ -1274,11 +1274,11 @@ If assist-key is pressed:
(unix-apropos-get-man)))
(defun smart-man-display (lisp-form)
- "Evaluates LISP-FORM returned from `smart-man-entry-ref' to display a man
page."
+ "Evaluate LISP-FORM returned from `smart-man-entry-ref' to display a man
page."
(eval lisp-form))
(defun smart-man-entry-ref ()
- "Returns form which displays referenced manual entry that point is on or nil.
+ "Return form which displays referenced manual entry that point is on or nil.
Handles references in sections: NAME, SEE ALSO, or PACKAGES USED. Also can
display C routine definitions selected in a man page, see
`smart-man-c-routine-ref'.
@@ -1321,7 +1321,7 @@ local variable containing its pathname."
(t ref))))
(defun smart-man-c-routine-ref ()
- "Returns form to jump to the definition of the C function whose name is at
point, if any, or nil
+ "Return form to jump to the definition of the C function whose name is at
point, if any, or nil
Valid sections within the man page are: ROUTINES, MACROS or FUNCTIONS.
Uses (smart-tags-file-list) function to determine the tags file from which to
locate the definition."
@@ -1343,7 +1343,7 @@ locate the definition."
(smart-tags-file-list (and (boundp 'man-path) man-path))))))
(defun smart-man-file-ref ()
- "Returns form to eval to display file whose name point is on, within a FILES
man page section.
+ "Return form to eval to display file whose name point is on, within a FILES
man page section.
If not on a file name, returns nil."
(let ((ref)
(opoint (point))
@@ -1390,15 +1390,15 @@ If not on a file name, returns nil."
0)))
(defun smart-outline ()
- "Collapses, expands, and moves outline entries.
-Invoked via a key press when in outline-mode. It assumes that
+ "Collapse, expand, and move outline entries.
+Invoked via a key press when in `outline-mode'. It assumes that
its caller has already checked that the key was pressed in an appropriate
buffer and has moved the cursor to the selected buffer.
If key is pressed:
(1) after an outline heading has been cut via the Action Key, then paste the
cut heading at point;
- (2) at the end of buffer, show all buffer text
+ (2) at the end of buffer, show all buffer text
(3) at the beginning of a heading line, cut the headings subtree from the
buffer;
(4) on a heading line but not at the beginning or end, if headings subtree is
@@ -1428,8 +1428,8 @@ If key is pressed:
(defun smart-outline-assist ()
- "Collapses, expands, and moves outline entries.
-Invoked via an assist-key press when in outline-mode. It assumes that
+ "Collaps, expand, and move outline entries.
+Invoked via an assist-key press when in `outline-mode'. It assumes that
its caller has already checked that the assist-key was pressed in an
appropriate
buffer and has moved the cursor to the selected buffer.
@@ -1450,7 +1450,7 @@ If assist-key is pressed:
((eobp) (outline-hide-body))
((and (bolp) (looking-at outline-regexp))
(setq smart-outline-cut t)
- (kill-region (point)
+ (kill-region (point)
;; Skip past start of current entry
(progn (re-search-forward outline-regexp nil t)
(smart-outline-to-entry-end
@@ -1463,7 +1463,7 @@ If assist-key is pressed:
(t (outline-hide-entry))))
(defun smart-outline-to-entry-end (&optional include-sub-entries
curr-entry-level)
- "Goes to end of whole entry if optional INCLUDE-SUB-ENTRIES is non-nil.
+ "Go to end of whole entry if optional INCLUDE-SUB-ENTRIES is non-nil.
CURR-ENTRY-LEVEL is an integer representing the length of the current level
string which matched to `outline-regexp'. If INCLUDE-SUB-ENTRIES is nil,
CURR-ENTRY-LEVEL is not needed."
@@ -1478,7 +1478,7 @@ CURR-ENTRY-LEVEL is not needed."
(goto-char (point-max)))))
(defun smart-outline-subtree-hidden-p ()
- "Returns t if at least initial subtree of heading is hidden, else nil."
+ "Return t if at least initial subtree of heading is hidden, else nil."
(and (outline-on-heading-p t)
(outline-invisible-in-p
(point) (or (save-excursion (re-search-forward "[\n\r]" nil t))
(point)))))
@@ -1524,9 +1524,9 @@ CURR-ENTRY-LEVEL is not needed."
;;; ************************************************************************
(defun smart-tar ()
- "Uses a single key or mouse key to manipulate tar file entries.
+ "Use a single key or mouse key to manipulate tar file entries.
-Invoked via a key press when in tar-mode. It assumes that its
+Invoked via a key press when in `tar-mode'. It assumes that its
caller has already checked that the key was pressed in an appropriate buffer
and has moved the cursor there.
@@ -1549,9 +1549,9 @@ If key is pressed:
(t (tar-extract-other-window))))
(defun smart-tar-assist ()
- "Uses a single assist-key or mouse assist-key to manipulate tar file entries.
+ "Use a single assist-key or mouse assist-key to manipulate tar file entries.
-Invoked via an assist-key press when in dired-mode. It assumes that its
+Invoked via an assist-key press when in `dired-mode'. It assumes that its
caller has already checked that the assist-key was pressed in an appropriate
buffer and has moved the cursor there.
diff --git a/hui-select.el b/hui-select.el
index aa91d8c..b953dee 100644
--- a/hui-select.el
+++ b/hui-select.el
@@ -16,7 +16,7 @@
;; Simply load this library and you are ready to try it out by
;; double-clicking on various kinds of characters in different buffer major
;; modes. You'll quickly get the hang of it. (It also provides a command
-;; to jump between beginning and end tags within HTML and SGML buffers.)
+;; to jump between beginning and end tags within HTML and SGML buffers.)
;;
;; A great deal of smarts are built-in so that it does the right thing
;; almost all of the time; many other attempts at similar behavior such as
@@ -61,7 +61,7 @@
;;
;; Four other commands are also provided:
;; `hui-select-and-copy-thing' - mark and copy the syntactical unit to the
-;; kill ring
+;; kill ring
;; `hui-select-and-kill-thing' - kill the syntactical unit at point
;; `hui-select-goto-matching-tag' - In HTML and SGML modes (actually any
;; listed in the variable, `hui-select-markup-modes'), move point to the
@@ -211,7 +211,7 @@
;;;###autoload
(defun hui-select-at-p (&optional pos)
- "Return non-nil if the character after optional POS (or point) matches a
syntax entry in `hui-select-syntax-alist'.
+ "Return non-nil if the character after optional POS (or point) match a
syntax entry in `hui-select-syntax-alist'.
The non-nil value returned is the function to call to select that syntactic
unit."
(interactive "d")
(unless (and (bobp) (eobp))
@@ -377,7 +377,7 @@ displayed in the minibuffer."
;;;###autoload
(defun hui-select-goto-matching-tag ()
- "If in a major mode listed in `hui-select-markup-modes,' moves point to the
start of the tag paired with the closest tag that point is within or precedes.
+ "If in a major mode listed in `hui-select-markup-modes,' move point to the
start of the tag paired with the closest tag that point is within or precedes.
Returns t if point is moved, else nil.
Signals an error if no tag is found following point or if the closing tag
does not have a `>' terminator character."
@@ -405,7 +405,7 @@ does not have a `>' terminator character."
(progn (backward-char 1)
(looking-at "<[^<> \t\n\r]"))))
;; No tag follows point.
- (t (error "(hui-select-goto-matching-tag): No tag found after point.")))
+ (t (error "(hui-select-goto-matching-tag): No tag found after point")))
(if (catch 'done
(cond
@@ -535,7 +535,7 @@ The character at POS is selected if no other thing is
matched."
(- (cdr region) (car region)))
(< region-size min-region))
(setq min-region region-size
- result
+ result
(list
;; The actual selection type is
;; sometimes different than the one we
@@ -602,7 +602,7 @@ If an error occurs during syntax scanning, it returns nil."
(hui-select-set-region pos (1+ pos)))))))
(defun hui-select-at-delimited-thing-p ()
- "Returns non-nil if point is at a markup pair, list, array/vector, set,
comment or string, else nil.
+ "Return non-nil if point is at a markup pair, list, array/vector, set,
comment or string, else nil.
The non-nil value returned is the function to call to select that syntactic
unit.
Ignores any match if on an Emacs button and instead returns nil."
@@ -619,7 +619,7 @@ Ignores any match if on an Emacs button and instead returns
nil."
(t hkey-value))))
(defun hui-select-delimited-thing ()
- "Selects a markup pair, list, array/vector, set, comment or string at point
and returns t, else nil."
+ "Select a markup pair, list, array/vector, set, comment or string at point
and return t, else nil."
(interactive)
(prog1 (and (hui-select-delimited-thing-call #'hui-select-thing) t)
;; If selected region is followed by only whitespace and then a
@@ -710,7 +710,7 @@ mail and news reply modes."
(setq this-command 'select-thing)))
(defun hui-select-delimited-thing-call (func)
- "Selects a markup pair, list, vector/array, set, comment or string at point
and returns non-nil, else nil.
+ "Select a markup pair, list, vector/array, set, comment or string at point
and return non-nil, else nil.
The non-nil value returned is the function to call to select that syntactic
unit."
(unless (and (memq major-mode hui-select-ignore-quoted-sexp-modes)
;; Ignore quoted identifier sexpressions, like #'function
@@ -768,7 +768,7 @@ Return the updated cons cell."
hui-select-region))
(defun hui-select-string-p (&optional start-delim end-delim)
- "Returns (start . end) of string whose first line point is within or
immediately before.
+ "Return (start . end) of string whose first line point is within or
immediately before.
Positions include delimiters. String is delimited by double quotes unless
optional START-DELIM and END-DELIM (strings) are given.
Returns nil if not within a string."
@@ -849,7 +849,7 @@ list, hui-select-brace-modes."
;; Must be at the first non-whitespace character in the line.
(and (= (point) (save-excursion
(hui-select-back-to-indentation)))
;; Must be on an alpha or symbol-constituent character.
- ;; Also allow ~ for C++ destructors.
+ ;; Also allow ~ for C++ destructors.
(looking-at "[a-zA-z~]\\|\\s_")
;; Previous line, if any, must be blank or a comment
;; start or end or we must be looking at
@@ -924,7 +924,7 @@ list, hui-select-indent-modes."
(when (memq major-mode hui-select-indent-modes)
(save-excursion
(goto-char pos)
- (if (and
+ (if (and
;; Use this function only if point is on the first non-blank
;; character of a block, whatever a block is for the current
;; mode.
@@ -933,7 +933,7 @@ list, hui-select-indent-modes."
((or (eq major-mode 'outline-mode) selective-display)
(save-excursion (beginning-of-line)
(looking-at outline-regexp)))
- ;; After indent in any other mode, must be on an alpha
+ ;; After indent in any other mode, must be on an alpha
;; or symbol-constituent character.
(t (looking-at "[a-zA-z]\\|\\s_")))
;; Must be at the first non-whitespace character in the line.
@@ -1008,7 +1008,7 @@ list, hui-select-indent-modes."
(defun hui-select-sexp (pos)
"Return (start . end) of the sexp that POS is within."
(setq hui-select-previous 'sexp)
- (save-excursion
+ (save-excursion
(goto-char pos)
(condition-case ()
(hui-select-set-region (progn (backward-up-list 1) (point))
@@ -1021,7 +1021,7 @@ list, hui-select-indent-modes."
;; Keep going up and backward in sexps. This means that hui-select-sexp-up
;; can only be called after hui-select-sexp or after itself.
(setq pos (or (car hui-select-region) pos))
- (save-excursion
+ (save-excursion
(goto-char pos)
(condition-case ()
(hui-select-set-region (progn (backward-up-list 1) (point))
@@ -1161,7 +1161,7 @@ included in the list, hui-select-brace-modes."
(hui-select-set-region (point) end))))))
(defun hui-select-string (pos)
- "Returns (start . end) of string at POS or nil. Pos include delimiters.
+ "Return (start . end) of string at POS or nil. Pos include delimiters.
Delimiters may be single, double or open and close quotes."
(setq hui-select-previous 'string)
(save-excursion
@@ -1184,7 +1184,7 @@ Delimiters may be single, double or open and close
quotes."
(defun hui-select-sentence (pos)
"Return (start . end) of the sentence at POS."
(setq hui-select-previous 'sentence)
- (save-excursion
+ (save-excursion
(goto-char pos)
(condition-case ()
(hui-select-set-region (progn (backward-sentence) (point))
@@ -1192,7 +1192,7 @@ Delimiters may be single, double or open and close
quotes."
(error nil))))
(defun hui-select-whitespace (pos)
- "Return (start . end) of all but one char of whitespace POS, unless
+ "Return (start . end) of all but one char of whitespace POS, unless
there is only one character of whitespace or this is leading whitespace on
the line. Then return all of it."
(setq hui-select-previous 'whitespace)
@@ -1292,7 +1292,7 @@ list, hui-select-markup-modes."
(progn
(if pos-with-space
;; Newline found after original end tag.
- (progn
+ (progn
(skip-chars-backward " \t")
(if (bolp)
;; Don't include final newline unless the
@@ -1324,7 +1324,7 @@ list, hui-select-markup-modes."
(defun hui-select-paragraph (pos)
"Return (start . end) of the paragraph at POS."
(setq hui-select-previous 'paragraph)
- (save-excursion
+ (save-excursion
(goto-char pos)
(if (looking-at paragraph-start) (forward-paragraph))
(hui-select-set-region (progn (backward-paragraph) (point))
@@ -1333,7 +1333,7 @@ list, hui-select-markup-modes."
(defun hui-select-page (pos)
"Return (start . end) of the page preceding POS."
(setq hui-select-previous 'page)
- (save-excursion
+ (save-excursion
(goto-char pos)
(hui-select-set-region (progn (backward-page) (point))
(progn (forward-page) (point)))))
diff --git a/hui-treemacs.el b/hui-treemacs.el
index 2cdface..5b93917 100644
--- a/hui-treemacs.el
+++ b/hui-treemacs.el
@@ -35,7 +35,7 @@
;;;###autoload
(defun smart-treemacs ()
- "Uses a single key or mouse key to manipulate directory entries.
+ "Use a single key or mouse key to manipulate directory entries.
Invoked via a key press when in treemacs-mode. It assumes that its
caller has already checked that the key was pressed in an appropriate buffer
@@ -105,3 +105,4 @@ Suitable for use as a value of
`action-key-modeline-buffer-id-function'."
(t (treemacs))))
(provide 'hui-treemacs)
+;;; hui-treemacs.el ends here
diff --git a/hui-window.el b/hui-window.el
index 8b5536f..fe35813 100644
--- a/hui-window.el
+++ b/hui-window.el
@@ -104,7 +104,7 @@ of screen control commands."
:group 'hyperbole-keys)
(defun hmouse-map-modes-to-form (mode-forms)
- "Maps over a sequence of (major-mode(s) form-to-eval) lists; returns items
with a single major-mode in the car, (major-mode form-to-eval)."
+ "Map over a sequence of (major-mode(s) form-to-eval) lists; return items
with a single `major-mode' in the car, (major-mode form-to-eval)."
(apply 'nconc
(mapcar (lambda (modes-form)
(if (sequencep (car modes-form))
@@ -133,7 +133,7 @@ of screen control commands."
(error "(hmouse-item-to-window): %s the treemacs package
for item dragging support"
(if (fboundp 'treemacs) "Update" "Install")))))
"List of (major-mode lisp-form) lists.
-The car of an item must be a major-mode symbol. The cadr of an item
+The car of an item must be a `major-mode' symbol. The cadr of an item
is a Lisp form to evaluate to get the item name at point (typically a
buffer, file or directory name whose contents will be displayed in the
drag release window.")
@@ -181,7 +181,7 @@ drag release window.")
;; If click in the minibuffer when it is not active (blank),
;; display the Hyperbole minibuffer menu or popup the jump menu.
((hmouse-inactive-minibuffer-p) .
- ((funcall action-key-minibuffer-function) .
+ ((funcall action-key-minibuffer-function) .
(funcall assist-key-minibuffer-function)))
((hmouse-drag-thing) .
((hmouse-yank-region) . (hmouse-kill-and-yank-region)))
@@ -356,7 +356,7 @@ Delimited constructs include lists, comments, strings,
(if (and (not (hmouse-use-region-p)) (hui-select-at-delimited-thing-p)
(or (markerp depress-args) (markerp release-args)
(and (not (or (hmouse-drag-window-side)
(hmouse-modeline-depress)))
- (or (hmouse-drag-between-windows)
(hmouse-drag-vertically)
+ (or (hmouse-drag-between-windows)
(hmouse-drag-vertically)
(hmouse-drag-horizontally)
(hmouse-drag-diagonally))))
(let ((start-buf (window-buffer (smart-window-of-coords
depress-args)))
(end-buf (window-buffer (smart-window-of-coords
release-args)))
@@ -398,7 +398,7 @@ Signals an error if the depress buffer is read-only."
;; In this case, we want an error that will terminate execution so that
;; hkey-region is not reset to nil. This allows the user to fix the
;; problem and then to try killing again.
- (error "(hmouse-kill-region): Use {%s} to enable killing from this
buffer."
+ (error "(hmouse-kill-region): Use {%s} to enable killing from this
buffer"
(hmouse-read-only-toggle-key))
(kill-region (or hkey-value (point)) (mark))))
@@ -412,9 +412,9 @@ Signals an error if either depress or release buffer is
read-only."
;; In this case, we want an error that will terminate execution so that
;; hkey-region is not reset to nil. This allows the user to fix the
;; problem and then to try killing again.
- (error "(hmouse-kill-and-yank-region): Use {%s} to enable killing from
this buffer."
+ (error "(hmouse-kill-and-yank-region): Use {%s} to enable killing from
this buffer"
(hmouse-read-only-toggle-key))
- ;; Depress and release may be in the same buffer, in which case,
+ ;; Depress and release may be in the same buffer, in which case,
;; save the release point that may change as a result of
;; the kill; also, before the kill, restore the point to where it
;; was when the region was set.
@@ -425,7 +425,7 @@ Signals an error if either depress or release buffer is
read-only."
;; In this case, we want an error that will terminate execution so
that
;; hkey-region is not reset to nil. This allows the user to fix the
;; problem and then to try yanking again.
- (error "(hmouse-kill-and-yank-region): Use {%s} to enable yanking
into this buffer."
+ (error "(hmouse-kill-and-yank-region): Use {%s} to enable yanking
into this buffer"
(hmouse-read-only-toggle-key))
;; Region may be in another buffer, so move there if so.
(hmouse-goto-region-prev-point)
@@ -453,7 +453,7 @@ Signals an error if the buffer is read-only."
;; In this case, we want an error that will terminate execution so that
;; hkey-region is not reset to nil. This allows the user to fix the
;; problem and then to try yanking again.
- (error "(hmouse-yank-region): Use {%s} to enable yanking into this
buffer."
+ (error "(hmouse-yank-region): Use {%s} to enable yanking into this
buffer"
(hmouse-read-only-toggle-key))
;; Permanently return to release point
(let ((release-window (if assist-flag assist-key-release-window
action-key-release-window)))
@@ -465,7 +465,7 @@ Signals an error if the buffer is read-only."
(error nil)))))
(defun hmouse-drag-between-frames ()
- "Returns non-nil if last Action Key depress and release were in different
frames.
+ "Return non-nil if last Action Key depress and release were in different
frames.
If free variable `assist-flag' is non-nil, uses Assist Key."
(if assist-flag
(and (window-live-p assist-key-depress-window)
@@ -478,7 +478,7 @@ If free variable `assist-flag' is non-nil, uses Assist Key."
(window-frame action-key-release-window))))))
(defun hmouse-drag-between-windows ()
- "Returns non-nil if last Action Key depress and release were in different
windows.
+ "Return non-nil if last Action Key depress and release were in different
windows.
If free variable `assist-flag' is non-nil, uses Assist Key."
(if assist-flag
(and (window-live-p assist-key-depress-window)
@@ -490,7 +490,7 @@ If free variable `assist-flag' is non-nil, uses Assist Key."
(not (eq action-key-depress-window action-key-release-window)))))
(defun hmouse-drag-same-window ()
- "Returns non-nil if last Action Key depress and release were in the same
window.
+ "Return non-nil if last Action Key depress and release were in the same
window.
If free variable `assist-flag' is non-nil, uses Assist Key."
(if assist-flag
(and (window-live-p assist-key-depress-window)
@@ -501,7 +501,7 @@ If free variable `assist-flag' is non-nil, uses Assist Key."
(eq action-key-depress-window action-key-release-window))))
(defun hmouse-drag-outside-all-windows ()
- "Returns non-nil if last Action Key release was outside of an Emacs window.
+ "Return non-nil if last Action Key release was outside of an Emacs window.
If free variable `assist-flag' is non-nil, uses Assist Key."
(if assist-flag
(and (window-live-p assist-key-depress-window) (not
assist-key-release-window))
@@ -527,7 +527,7 @@ items in other modes."
t))
(defun hmouse-drag-diagonally ()
- "Returns non-nil iff last Action Key use was a diagonal drag within a single
window.
+ "Return non-nil iff last Action Key use was a diagonal drag within a single
window.
If free variable `assist-flag' is non-nil, uses Assist Key.
Value returned is nil if not a diagonal drag, or one of the following symbols
depending on the direction of the drag: southeast, southwest, northwest,
northeast."
@@ -558,7 +558,7 @@ depending on the direction of the drag: southeast,
southwest, northwest, northea
'southwest 'northwest)))))))
(defun hmouse-drag-horizontally ()
- "Returns non-nil iff last Action Key use was a horizontal drag within a
single window.
+ "Return non-nil iff last Action Key use was a horizontal drag within a
single window.
If free variable `assist-flag' is non-nil, uses Assist Key.
Value returned is nil if not a horizontal drag, 'left if drag moved left or
'right otherwise."
@@ -586,7 +586,7 @@ Value returned is nil if not a horizontal drag, 'left if
drag moved left or
(if (< last-depress-x last-release-x) 'right 'left)))))
(defun hmouse-drag-vertically-within-emacs ()
- "Returns non-nil iff last Action Key use was a vertical drag that started
and ended within the same Emacs frame.
+ "Return non-nil iff last Action Key use was a vertical drag that started and
ended within the same Emacs frame.
If free variable `assist-flag' is non-nil, uses Assist Key.
Value returned is nil if not a vertical line drag, 'up if drag moved up or
'down otherwise."
@@ -615,7 +615,7 @@ Value returned is nil if not a vertical line drag, 'up if
drag moved up or
(if (< last-depress-y last-release-y) 'down 'up)))))
(defun hmouse-drag-vertically ()
- "Returns non-nil iff last Action Key use was a vertical drag within a single
window.
+ "Return non-nil iff last Action Key use was a vertical drag within a single
window.
If free variable `assist-flag' is non-nil, uses Assist Key.
Value returned is nil if not a vertical line drag, 'up if drag moved up or
'down otherwise."
@@ -623,7 +623,7 @@ Value returned is nil if not a vertical line drag, 'up if
drag moved up or
(hmouse-drag-vertically-within-emacs)))
(defun hmouse-drag-window-side ()
- "Returns non-nil if Action Key was dragged from a window side divider and
released in the same window.
+ "Return non-nil if Action Key was dragged from a window side divider and
released in the same window.
If free variable `assist-flag' is non-nil, uses Assist Key."
(cond ((hyperb:window-system)
(let* ((depress-args (if assist-flag assist-key-depress-args
@@ -642,14 +642,14 @@ If free variable `assist-flag' is non-nil, uses Assist
Key."
hmouse-side-sensitivity))))))
(defun hmouse-read-only-toggle-key ()
- "Return the first key binding that toggles read-only mode, or nil if none."
+ "Return the first key binding that toggle read-only mode, or nil if none."
(key-description (or (where-is-internal #'read-only-mode nil t)
(where-is-internal #'vc-toggle-read-only nil t)
(where-is-internal #'toggle-read-only nil t))))
(defun hmouse-vertical-action-drag ()
- "Handles an Action Key vertical drag within a window: adds a window to the
right of this one.
-Beeps and prints message if the window cannot be split further."
+ "Handle an Action Key vertical drag within a window: add a window to the
right of this one.
+Beep and print message if the window cannot be split further."
(interactive)
(condition-case ()
(split-window-horizontally nil)
@@ -657,16 +657,16 @@ Beeps and prints message if the window cannot be split
further."
(message "(hmouse-vertical-action-drag): Can't split the window
further."))))
(defun hmouse-vertical-assist-drag ()
- "Handles an Assist Key vertical drag within a window: deletes the current
window.
-Beeps and prints message if the window cannot be split further."
+ "Handle an Assist Key vertical drag within a window: deletes the current
window.
+Beep and print message if the window cannot be split further."
(condition-case ()
(delete-window)
(error (beep)
(message "(hmouse-vertical-assist-drag): A single window cannot be
deleted."))))
(defun hmouse-horizontal-action-drag ()
- "Handles an Action Key horizontal drag within a window: adds a window below
this one.
-Beeps and prints message if the window cannot be split further."
+ "Handle an Action Key horizontal drag within a window: add a window below
this one.
+Beep and print message if the window cannot be split further."
(interactive)
(condition-case ()
(if (fboundp 'split-window-quietly)
@@ -676,15 +676,15 @@ Beeps and prints message if the window cannot be split
further."
(message "(hmouse-horizontal-action-drag): Can't split the window
further."))))
(defun hmouse-horizontal-assist-drag ()
- "Handles an Assist Key horizontal drag within a window: deletes the current
window.
-Beeps and prints message if the window cannot be split further."
+ "Handle an Assist Key horizontal drag within a window: delete the current
window.
+Beep and print message if the window cannot be split further."
(condition-case ()
(delete-window)
(error (beep)
(message "(hmouse-horizontal-assist-drag): A single window cannot be
deleted."))))
(defun smart-coords-in-window-p (coords window)
- "Tests if COORDS are in WINDOW. Returns WINDOW if they are, nil otherwise."
+ "Test if COORDS are in WINDOW. Return WINDOW if they are, nil otherwise."
(cond ((null coords) nil)
((eventp coords)
(let ((w-or-f (posn-window (event-start coords))))
@@ -703,7 +703,7 @@ Beeps and prints message if the window cannot be split
further."
window)))))
(defun smart-point-of-coords (coords)
- "Returns point within window in which COORDS fall or nil if none.
+ "Return point within window in which COORDS fall or nil if none.
Ignores minibuffer window."
(cond ((markerp coords)
(marker-position coords))
@@ -711,7 +711,7 @@ Ignores minibuffer window."
(posn-point (event-start coords)))))
(defun smart-window-of-coords (coords)
- "Returns window in which COORDS fall or nil if none.
+ "Return window in which COORDS fall or nil if none.
Ignores minibuffer window."
(cond ((null coords) nil)
((markerp coords)
@@ -753,7 +753,7 @@ With optional boolean NEW-WINDOW non-nil, sensibly split
the release window befo
"Display an error when a region is active and in-window drags are not
allowed."
;; Return point to where it was prior to depress so the region does not
permanently change.
(goto-char hkey-value)
- (error "(hmouse-drag-region-active): Region is active; use a Smart Key
press/click within a window, not a drag."))
+ (error "(hmouse-drag-region-active): Region is active; use a Smart Key
press/click within a window, not a drag"))
(defun hmouse-set-buffer-and-point (buffer point)
(when buffer
@@ -935,12 +935,12 @@ If the Assist Key is:
(t (hmouse-modeline-resize-window)))))
(defun hmouse-modeline-click ()
- "Returns non-nil if last Smart Key depress and release were at a single
point (less than drag tolerance apart) in a modeline."
+ "Return non-nil if last Smart Key depress and release were at a single point
(less than drag tolerance apart) in a modeline."
(and (hmouse-modeline-release) (hmouse-modeline-depress)
(not (or (hmouse-drag-horizontally) (hmouse-drag-vertically)
(hmouse-drag-diagonally)))))
(defun hmouse-emacs-modeline-event-p (event)
- "GNU Emacs: Returns non-nil if EVENT happened on a window mode line."
+ "GNU Emacs: Return non-nil if EVENT happened on a window mode line."
(or (and (eventp event) (eq (posn-area (event-start event)) 'mode-line))
;; If drag release was to an unselected frame mode-line, on
;; click-to-focus systems, the release event will not include
@@ -954,7 +954,7 @@ If the Assist Key is:
last-press-y mode-ln (< (- mode-ln last-press-y) line-height)))))
(defun hmouse-modeline-event-p (event)
- "Returns non-nil if start of EVENT happened on a window mode line."
+ "Return non-nil if start of EVENT happened on a window mode line."
(when (and (hyperb:window-system) event
(not (posnp event))
(not (markerp event)))
@@ -976,7 +976,7 @@ If the Assist Key is:
(and last-press-y mode-ln (= last-press-y mode-ln)))))))
(defun hmouse-modeline-depress ()
- "Returns non-nil if Action Key was depressed on a window mode line.
+ "Return non-nil if Action Key was depressed on a window mode line.
If free variable `assist-flag' is non-nil, uses Assist Key."
(let ((args (if assist-flag
assist-key-depress-args
@@ -984,7 +984,7 @@ If free variable `assist-flag' is non-nil, uses Assist Key."
(hmouse-modeline-event-p args)))
(defun hmouse-modeline-release ()
- "Returns non-nil if Smart Key was released on a window mode line."
+ "Return non-nil if Smart Key was released on a window mode line."
(let ((args (if assist-flag
assist-key-release-args
action-key-release-args)))
@@ -1029,10 +1029,10 @@ of the Smart Key."
(cond
((>= (+ mode-ln 2) (frame-height))
(error
- "(hmouse-modeline-resize-window): Can't move bottom window in
frame."))
+ "(hmouse-modeline-resize-window): Can't move bottom window in
frame"))
((< (length (hypb:window-list 'no-minibuf)) 2)
(error
- "(hmouse-modeline-resize-window): Can't resize sole window in
frame."))
+ "(hmouse-modeline-resize-window): Can't resize sole window in
frame"))
(t (unwind-protect
(progn
(select-window window)
@@ -1083,7 +1083,7 @@ is non-nil, leave the original window and just clone it
into the new frame."
(delete-window depress-window)))))))
(defun hmouse-release-left-edge ()
- "Returns non-nil if last Smart Key release was at left window edge.
+ "Return non-nil if last Smart Key release was at left window edge.
`hmouse-edge-sensitivity' value determines how near to actual edge the
release must be.
@@ -1094,7 +1094,7 @@ mode-line regardless of the setting of
`hmouse-edge-sensitivity'."
(let ((args (if assist-flag assist-key-release-args
action-key-release-args))
window-left last-release-x)
- (if (fboundp 'window-lowest-p) ;; XEmacs >= 19.12
+ (if (fboundp 'window-lowest-p) ;; XEmacs >= 19.12
(setq last-release-x (and args (eq (event-window args)
(selected-window))
(hmouse-x-coord args))
@@ -1106,13 +1106,13 @@ mode-line regardless of the setting of
`hmouse-edge-sensitivity'."
(>= (- last-release-x window-left) 0))))
(defun hmouse-release-right-edge ()
- "Returns non-nil if the last Smart Key release was at right window edge.
+ "Return non-nil if the last Smart Key release was at right window edge.
`hmouse-edge-sensitivity' value determines how near to actual edge the
release must be."
(let ((args (if assist-flag assist-key-release-args
action-key-release-args))
window-right last-release-x)
- (if (fboundp 'window-lowest-p) ;; XEmacs >= 19.12
+ (if (fboundp 'window-lowest-p) ;; XEmacs >= 19.12
(setq last-release-x (and args (eq (event-window args)
(selected-window))
(hmouse-x-coord args))
@@ -1150,10 +1150,10 @@ of the Smart Key."
(cond
((>= (+ right-side-ln 2) (frame-width))
(error
- "(hmouse-resize-window-side): Can't change width of full frame
width window."))
+ "(hmouse-resize-window-side): Can't change width of full frame
width window"))
((< (length (hypb:window-list 'no-minibuf)) 2)
(error
- "(hmouse-resize-window-side): Can't resize sole window in
frame."))
+ "(hmouse-resize-window-side): Can't resize sole window in frame"))
(t (unwind-protect
(progn
(select-window window)
@@ -1170,7 +1170,7 @@ of the Smart Key."
(w2-buf (and w2 (window-buffer w2)))
)
(cond ((not (and w1 w2))
- (error "(hmouse-swap-buffers): Last depress or release was not
within a window."))
+ (error "(hmouse-swap-buffers): Last depress or release was not
within a window"))
((eq w1 w2)
;; Do nothing silently.
)
@@ -1190,7 +1190,7 @@ of the Smart Key."
(w2-height (and w2 (window-height w2)))
)
(or (and w1 w2)
- (error "(hmouse-swap-windows): Last depress or release was not within a
window."))
+ (error "(hmouse-swap-windows): Last depress or release was not within a
window"))
(unwind-protect
(progn
(select-window w1)
@@ -1210,7 +1210,7 @@ of the Smart Key."
)))
(defun hmouse-x-coord (args)
- "Returns x coordinate in characters from window system dependent ARGS or
nil."
+ "Return x coordinate in characters from window system dependent ARGS or nil."
(let ((x (if (markerp args)
(save-excursion
(hypb:goto-marker args)
@@ -1230,7 +1230,7 @@ of the Smart Key."
(if (integerp x) x)))
(defun hmouse-y-coord (args)
- "Returns y coordinate in frame lines from window system dependent ARGS or
nil."
+ "Return y coordinate in frame lines from window system dependent ARGS or
nil."
(let ((y (eval (cdr (assoc (hyperb:window-system)
'(("emacs" . (progn (if (eventp args) (setq args
(event-start args)))
(cond ((posnp args)
diff --git a/hui.el b/hui.el
index 1138f0f..43599d4 100644
--- a/hui.el
+++ b/hui.el
@@ -85,7 +85,7 @@ Default is the current button."
(hui:but-flash) (hbut:act but))))
(defun hui:ebut-create (&optional start end)
- "Creates an explicit Hyperbole button starting from label between optional
START and END.
+ "Create an explicit Hyperbole button starting from label between optional
START and END.
Indicates by delimiting and adding any necessary instance number of the button
label."
(interactive (list (and (marker-position (hypb:mark-marker t))
@@ -125,10 +125,10 @@ Signals an error if point is not within a button."
nil)))
(cond ((null but-key)
(hypb:error
- "(ebut-delete): Point is not over the label of an existing button."))
+ "(ebut-delete): Point is not over the label of an existing button"))
((not (stringp but-key))
(hypb:error
- "(ebut-delete): Invalid label key argument: '%s'." but-key)))
+ "(ebut-delete): Invalid label key argument: '%s'" but-key)))
(let ((interactive (called-interactively-p 'interactive)))
(if (and hui:ebut-delete-confirm-p interactive)
(if (y-or-n-p (format "Delete button %s%s%s? "
@@ -139,7 +139,7 @@ Signals an error if point is not within a button."
(hui:ebut-delete-op interactive but-key key-src))))
(defun hui:ebut-edit ()
- "Creates or modifies an explicit Hyperbole button when conditions are met.
+ "Create or modifies an explicit Hyperbole button when conditions are met.
A region must have been delimited with the action-key and point must now be
within it before this function is called or it will do nothing. The region
must be no larger than the size given by 'ebut:max-len'. It must be entirely
@@ -177,7 +177,7 @@ Signals an error when no such button is found in the
current buffer."
(unless (setq but (ebut:get lbl-key but-buf))
(pop-to-buffer but-buf)
- (hypb:error "(ebut-modify): Invalid button, no data for '%s'." lbl))
+ (hypb:error "(ebut-modify): Invalid button, no data for '%s'" lbl))
(setq new-lbl
(hargs:read
@@ -217,11 +217,11 @@ Signals an error if any problem occurs."
(setq curr-label hui:ebut-label-prev
new-label (ebut:label-p 'as-label))
(setq new-label nil
- curr-label
+ curr-label
(or (ebut:label-p 'as-label)
(let ((buts (ebut:alist)))
(if (null buts)
- (hypb:error "(ebut-rename): No explicit buttons in
buffer.")
+ (hypb:error "(ebut-rename): No explicit buttons in
buffer")
(prog1 (hargs:read-match
"Button label to rename: "
buts nil t nil 'ebut)
@@ -248,7 +248,7 @@ Signals an error if any problem occurs."
(hypb:error "(ebut-rename): 'new-label' must be a non-empty string:
%s"
new-label)))
(or (ebut:get (ebut:label-to-key curr-label))
- (hypb:error "(ebut-rename): Can't rename %s since no button data."
+ (hypb:error "(ebut-rename): Can't rename %s since no button data"
curr-label)))
(cond (new-label
(ebut:operate curr-label new-label)
@@ -257,10 +257,10 @@ Signals an error if any problem occurs."
(curr-label
(setq hui:ebut-label-prev curr-label)
(message "Edit button label and use same command to finish rename."))
- (t (hypb:error "(ebut-rename): Move point to within a button label."))))
+ (t (hypb:error "(ebut-rename): Move point to within a button label"))))
(defun hui:ebut-search (string &optional match-part)
- "Shows lines of files/buffers containing an explicit but match for STRING.
+ "Show lines of files/buffers containing an explicit but match for STRING.
Returns number of buttons matched and displayed.
By default, only matches for whole button labels are found, optional MATCH-PART
enables partial matches. The match lines are shown in a buffer which serves as
@@ -268,7 +268,7 @@ a menu to find any of the occurrences."
(interactive (list (read-string "Search for button string: ")
(y-or-n-p "Enable partial matches? ")))
(if (not (stringp string))
- (hypb:error "(ebut-search): String to search for is required."))
+ (hypb:error "(ebut-search): String to search for is required"))
(let* ((prefix (if (> (length string) 14)
(substring string 0 13) string))
(out-buf (get-buffer-create (concat "*" prefix " Hypb Search*")))
@@ -294,10 +294,10 @@ a menu to find any of the occurrences."
total))))
(defun hui:error (&rest args)
- (hypb:error "(hui:error): Obsolete, use hypb:error instead."))
+ (hypb:error "(hui:error): Obsolete, use hypb:error instead"))
(defun hui:gbut-create (lbl)
- "Creates Hyperbole explicit global button with LBL.
+ "Create Hyperbole explicit global button with LBL.
To create an implicit global button, add the text for an implicit
button to `gbut:file` and then with point on the implicit button,
@@ -345,7 +345,7 @@ Signals an error when no such button is found."
(unless (setq but (gbut:get lbl-key))
(pop-to-buffer but-buf)
- (hypb:error "(gbut-modify): Invalid button, no data for '%s'." lbl))
+ (hypb:error "(gbut-modify): Invalid button, no data for '%s'" lbl))
(setq new-lbl
(hargs:read
@@ -378,7 +378,7 @@ Signals an error when no such button is found."
(hui:ibut-message t)))))))
(defun hui:hbut-act (&optional but)
- "Executes action for optional Hyperbole button symbol BUT in current buffer.
+ "Execute action for optional Hyperbole button symbol BUT in current buffer.
Default is the current button."
(interactive
(let ((but (hbut:at-p)) (lst))
@@ -388,11 +388,11 @@ Default is the current button."
(hbut:get (hbut:label-to-key
(hargs:read-match "Button to execute: " lst nil t
(hbut:label-p 'as-label) 'hbut))))
- (t (hypb:error "(hbut-act): No labeled buttons in buffer."))))))
+ (t (hypb:error "(hbut-act): No labeled buttons in buffer"))))))
(cond ((and (called-interactively-p 'interactive) (null but))
- (hypb:error "(hbut-act): No current button to activate."))
+ (hypb:error "(hbut-act): No current button to activate"))
((not (hbut:is-p but))
- (hypb:error "(hbut-act): Button is invalid; it has no attributes."))
+ (hypb:error "(hbut-act): Button is invalid; it has no attributes"))
(t (or but (setq but 'hbut:current))
(hui:but-flash) (hbut:act but))))
@@ -401,13 +401,13 @@ Default is the current button."
(interactive)
(let ((but (hbut:at-p)))
(cond ((null but)
- (hypb:error "(hbut-act): No current button to activate."))
+ (hypb:error "(hbut-act): No current button to activate"))
((not (hbut:is-p but))
- (hypb:error "(hbut-act): Button is invalid; it has no attributes."))
+ (hypb:error "(hbut-act): Button is invalid; it has no attributes"))
(t (hui:but-flash) (hbut:act but)))))
(defun hui:hbut-help (&optional but)
- "Checks for and explains an optional button given by symbol, BUT.
+ "Check for and explain an optional button given by symbol, BUT.
BUT defaults to the button whose label point is within."
(interactive)
(setq but (or but (hbut:at-p)
@@ -415,13 +415,13 @@ BUT defaults to the button whose label point is within."
(hargs:read-match "Help for button: "
(ebut:alist) nil t nil 'ebut)))))
(unless but
- (hypb:error "(hbut-help): Move point to a valid Hyperbole button."))
+ (hypb:error "(hbut-help): Move point to a valid Hyperbole button"))
(unless (hbut:is-p but)
- (cond (but (hypb:error "(hbut-help): Invalid button."))
+ (cond (but (hypb:error "(hbut-help): Invalid button"))
(t (hypb:error
- "(hbut-help): Not on an implicit button and no buffer explicit
buttons."))))
+ "(hbut-help): Not on an implicit button and no buffer explicit
buttons"))))
(let ((type-help-func (intern-soft
- (concat
+ (concat
(htype:names 'ibtypes (hattr:get but 'categ))
":help"))))
(unless (equal (hypb:indirect-function 'hui:but-flash)
@@ -438,7 +438,7 @@ BUT defaults to the button whose label point is within."
(when total (hui:help-ebut-highlight))))))
(defun hui:hbut-label (default-label func-name)
- "Reads button label from user using DEFAULT-LABEL and caller's FUNC-NAME."
+ "Read button label from user using DEFAULT-LABEL and caller's FUNC-NAME."
(hargs:read "Button label: "
(lambda (lbl)
(and (not (string= lbl "")) (<= (length lbl) ebut:max-len)))
@@ -448,15 +448,15 @@ BUT defaults to the button whose label point is within."
'string))
(defun hui:hbut-label-default (start end &optional skip-len-test)
- "Returns default label based on START and END region markers or points.
+ "Return default label based on START and END region markers or points.
Optional SKIP-LEN-TEST means don't limit label to `ebut:max-len' length.
-Returns nil if START or END are invalid or if region fails length test.
+Returns nil if START or END are invalid or if region fails length test.
Also has side effect of moving point to start of default label, if any."
(if (markerp start) (setq start (marker-position start)))
(if (markerp end) (setq end (marker-position end)))
;; Test whether to use region as default button label.
- (if (and (integerp start) (integerp end)
+ (if (and (integerp start) (integerp end)
(or skip-len-test
(<= (max (- end start) (- start end)) ebut:max-len)))
(progn (goto-char start)
@@ -543,7 +543,7 @@ Signals an error when no such button is found in the
current buffer."
(hui:ibut-message t)))))
(defun hui:link-directly ()
- "Creates a Hyperbole link button at depress point, linked to release point.
+ "Create a Hyperbole link button at depress point, linked to release point.
See also documentation for `hui:link-possible-types'."
(let* ((link-types (hui:link-possible-types))
(but-window action-key-depress-window)
@@ -571,7 +571,7 @@ See also documentation for `hui:link-possible-types'."
(select-window release-window)
(cond ((= num-types 0)
- (error "(link-directly): No possible link type to create."))
+ (error "(link-directly): No possible link type to create"))
((= num-types 1)
(setq type-and-args (hui:list-remove-text-properties (car
link-types)))
(hui:link-create but-modify but-window lbl-key but-loc but-dir
type-and-args))
@@ -584,7 +584,7 @@ See also documentation for `hui:link-possible-types'."
(mapcar
(lambda (type-and-args)
(setq type (car type-and-args))
- (list
+ (list
(capitalize
(if (string-match
"^\\(link-to\\|eval\\)-"
@@ -608,7 +608,7 @@ See also documentation for `hui:link-possible-types'."
;;; ************************************************************************
(defun hui:action (actype &optional prompt)
- "Prompts for and returns an action to override action from ACTYPE."
+ "Prompt for and return an action to override action from ACTYPE."
(and actype
(let* ((act) (act-str)
(params (actype:params actype))
@@ -665,7 +665,7 @@ See also documentation for `hui:link-possible-types'."
(defun hui:actype (&optional default-actype prompt)
"Using optional DEFAULT-ACTYPE, PROMPTs for a button action type.
-DEFAULT-ACTYPE may be a valid symbol or symbol-name."
+DEFAULT-ACTYPE may be a valid symbol or `symbol-name'."
(and default-actype (symbolp default-actype)
(progn
(setq default-actype (symbol-name default-actype))
@@ -677,7 +677,7 @@ DEFAULT-ACTYPE may be a valid symbol or symbol-name."
(hargs:read-match (or prompt "Button's action type: ")
(mapcar 'list (htype:names 'actypes))
nil t default-actype 'actype)))
- (hypb:error "(actype): Invalid default action type received.")))
+ (hypb:error "(actype): Invalid default action type received")))
(defun hui:buf-writable-err (but-buf func-name)
"If BUT-BUF is read-only, signal an error from FUNC-NAME."
@@ -688,7 +688,7 @@ DEFAULT-ACTYPE may be a valid symbol or symbol-name."
;; (if unwritable
;; Commented error out since some people want to be able to create
;; buttons within files which they have purposely marked read-only.
- ;; (setq err
+ ;; (setq err
;; (format "(ebut-modify): Hyperbole lacks permission to write to
'%s'."
;; (file-name-nondirectory buffer-file-name))))
(if buffer-read-only
@@ -713,7 +713,7 @@ DEFAULT-ACTYPE may be a valid symbol or symbol-name."
(if (and (not (string-match "mail\\*" b))
(not (string-match "\\*post-news\\*" b))
(string-match "\\`[* ]" b))
- nil
+ nil
(cons b nil))))
(buffer-list)))
nil t (buffer-name) 'buffer))
@@ -735,10 +735,10 @@ within."
((and (stringp key-src)
(setq buf (find-file-noselect key-src)))
(setq ebut (ebut:get but-key buf)))
- (t (hypb:error "(ebut-delete): Invalid key-src: '%s'."
key-src)))
+ (t (hypb:error "(ebut-delete): Invalid key-src: '%s'" key-src)))
(if ebut
(ebut:delete ebut)
- (hypb:error "(ebut-delete): No valid %s button in %s."
+ (hypb:error "(ebut-delete): No valid %s button in %s"
(ebut:key-to-label but-key) buf))
)
(progn (set-buffer buf)
@@ -749,10 +749,10 @@ within."
(hui:ebut-unmark but-key key-src))
(if (hmail:reader-p) (hmail:msg-narrow))
)
- (hypb:error "(ebut-delete): You may not delete buttons from this
buffer."))))
+ (hypb:error "(ebut-delete): You may not delete buttons from this
buffer"))))
(defun hui:ebut-delimit (start end instance-str)
- (hypb:error "(hui:ebut-delimit): Obsolete, use ebut:delimit instead."))
+ (hypb:error "(hui:ebut-delimit): Obsolete, use ebut:delimit instead"))
(defun hui:ebut-message (but-modify-flag)
(let ((actype (symbol-name (hattr:get 'hbut:current 'actype)))
@@ -814,10 +814,10 @@ All args are optional, the current button and buffer file
are the defaults."
(or cur-p (save-buffer)))))))))
(defun hui:file-find (file-name)
- "If FILE-NAME is readable, finds it, else signals an error."
+ "If FILE-NAME is readable, find it, else signal an error."
(if (and (stringp file-name) (file-readable-p file-name))
(find-file file-name)
- (hypb:error "(file-find): \"%s\" does not exist or is not readable."
+ (hypb:error "(file-find): \"%s\" does not exist or is not readable"
file-name)))
(defun hui:hbut-term-highlight (start end)
@@ -909,7 +909,7 @@ Optional NO-SORT means display in decreasing priority order
(natural order)."
doc-list)))))
(defun hui:htype-help-current-window (htype-sym &optional no-sort)
- "Displays in the current window, documentation for types from HTYPE-SYM
which match to a regexp.
+ "Display in the current window, documentation for types from HTYPE-SYM which
match to a regexp.
Optional NO-SORT means display in decreasing priority order (natural order)."
(let ((display-buffer-alist
'(("\\`*Help" . ((lambda (buf _alist) (switch-to-buffer buf)))))))
@@ -928,16 +928,16 @@ Optional NO-SORT means display in decreasing priority
order (natural order)."
(cons actype args))))
(defun hui:key-dir (but-buf)
- "Returns button key src directory based on BUT-BUF, a buffer."
+ "Return button key src directory based on BUT-BUF, a buffer."
(if (bufferp but-buf)
(let ((file (buffer-file-name but-buf)))
(if file
(file-name-directory (hpath:symlink-referent file))
(buffer-local-value 'default-directory but-buf)))
- (hypb:error "(hui:key-dir): '%s' is not a valid buffer.")))
+ (hypb:error "(hui:key-dir): '%s' is not a valid buffer")))
(defun hui:key-src (but-buf)
- "Returns button key src location based on BUT-BUF, a buffer.
+ "Return button key src location based on BUT-BUF, a buffer.
This is BUT-BUF when button data is stored in the buffer and the
button's source file name when the button data is stored externally."
(with-current-buffer but-buf
@@ -946,13 +946,13 @@ button's source file name when the button data is stored
externally."
(t but-buf))))
(defun hui:link-create (modify but-window lbl-key but-loc but-dir
type-and-args)
- "Creates or modifies a new Hyperbole explicit link button.
+ "Create or modify a new Hyperbole explicit link button.
If MODIFY is non-nil, modifies button at point in BUT-WINDOW,
otherwise, prompts for button label and creates a button.
LBL-KEY is internal form of button label. BUT-LOC is file or buffer
in which to create button. BUT-DIR is directory of BUT-LOC.
TYPE-AND-ARGS is the action type for the button followed by any
-arguments it requires. Any text properties are removed from string
arguments."
+arguments it requires. Any text properties are removed from string arguments."
(hattr:set 'hbut:current 'loc but-loc)
(hattr:set 'hbut:current 'dir but-dir)
(hattr:set 'hbut:current 'actype (intern-soft
@@ -965,7 +965,7 @@ arguments it requires. Any text properties are removed
from string arguments."
(ebut:operate label (if modify label))))
(defun hui:link-possible-types ()
- "Returns list of possible link action types during editing of a Hyperbole
button.
+ "Return list of possible link action types during editing of a Hyperbole
button.
Each list element is a list of the link type and any arguments it requires.
The link types considered are fixed; this function must be changed to alter
@@ -1056,7 +1056,7 @@ Buffer without File link-to-buffer-tmp"
))))
(defun hui:list-remove-text-properties (lst)
- "Returns LST, a list, with text properties removed from any string elements."
+ "Return LST, a list, with text properties removed from any string elements."
(mapcar (lambda (elt) (if (stringp elt) (substring-no-properties elt) elt))
lst))
diff --git a/hvar.el b/hvar.el
index 5323935..9fe7e85 100644
--- a/hvar.el
+++ b/hvar.el
@@ -24,7 +24,7 @@
;;;###autoload
(defun var:add-and-run-hook (hook hook-function)
- "Adds to HOOK (a symbol ending with -hook) HOOK-FUNCTION and then calls
HOOK-FUNCTION in every buffer with the matching major mode based on HOOK's
name."
+ "Add to HOOK (a symbol ending with -hook) HOOK-FUNCTION and then call
HOOK-FUNCTION in every buffer with the matching major mode based on HOOK's
name."
(add-hook hook hook-function)
(let* ((hook-name (symbol-name hook))
(mode (if (string-match "-hooks?\\'" hook-name)
@@ -40,14 +40,14 @@ The ones that were removed by var:remove-all at some point."
;;;###autoload
(defun var:append (var-symbol list-to-add)
- "Appends to value held by VAR-SYMBOL, LIST-TO-ADD. Returns new value.
+ "Append to value held by VAR-SYMBOL, LIST-TO-ADD. Return new value.
If VAR-SYMBOL is unbound, it is set to LIST-TO-ADD.
-Used to append to hook variables. Stores all values for later removal.
-Does nothing when `inhibit-hyperbole-messaging' is non-nil."
+Use to append to hook variables. Store all values for later removal.
+Do nothing when `inhibit-hyperbole-messaging' is non-nil."
(if (not (symbolp var-symbol))
- (error "(var:append): First argument, `%s', must be a symbol (not a
string)." var-symbol))
+ (error "(var:append): First argument, `%s', must be a symbol (not a
string)" var-symbol))
(if (or (null list-to-add) (not (listp list-to-add)))
- (error "(var:append): Second argument, `%s', must be a non-empty list."
list-to-add))
+ (error "(var:append): Second argument, `%s', must be a non-empty list"
list-to-add))
(unless inhibit-hyperbole-messaging
(let ((val) result)
(setq result
@@ -64,12 +64,12 @@ Does nothing when `inhibit-hyperbole-messaging' is non-nil."
(symbol-value var-symbol))))
(defun var:remove (var-symbol list-to-remove)
- "Removes from VAR-SYMBOL the functions in LIST-TO-REMOVE.
-Used to remove from hook variables."
+ "Remove from VAR-SYMBOL the functions in LIST-TO-REMOVE.
+Use to remove from hook variables."
(if (not (symbolp var-symbol))
- (error "(var:remove): First argument, `%s', must be a symbol (not a
string)." var-symbol))
+ (error "(var:remove): First argument, `%s', must be a symbol (not a
string)" var-symbol))
(if (or (null list-to-remove) (not (listp list-to-remove)))
- (error "(var:remove): Second argument, `%s', must be a non-empty list."
list-to-remove))
+ (error "(var:remove): Second argument, `%s', must be a non-empty list"
list-to-remove))
(if (eq (car list-to-remove) 'lambda)
(setq list-to-remove (list list-to-remove)))
(mapc (lambda (func) (remove-hook var-symbol func))
diff --git a/hversion.el b/hversion.el
index 3b92729..6b2e17e 100644
--- a/hversion.el
+++ b/hversion.el
@@ -122,7 +122,7 @@ the pathname."
file)))))
(defun hyperb:window-sys-term (&optional frame)
- "Returns the first part of the term-type if running under a window system,
else nil.
+ "Return the first part of the term-type if running under a window system,
else nil.
Where a part in the term-type is delimited by a `-' or an `_'."
(unless frame (setq frame (selected-frame)))
(let* ((display-type (if (fboundp 'device-type) (device-type) window-system))
@@ -145,7 +145,7 @@ Where a part in the term-type is delimited by a `-' or an
`_'."
term))
(defun hyperb:window-system (&optional frame)
- "Returns the string name for window system or term type under which the
selected frame is running.
+ "Return the string name for window system or term type under which the
selected FRAME is running.
If nil after system initialization, no window system or mouse support is
available."
(unless frame (setq frame (selected-frame)))
(frame-parameter frame 'hyperb:window-system))
@@ -155,7 +155,7 @@ If nil after system initialization, no window system or
mouse support is availab
;; each frame.
(mapc #'hyperb:window-sys-term (frame-list))
;; Ensure this next hook is appended so that if follows the hook that
-;; selects the new frame.
+;; selects the new frame.
(add-hook 'after-make-frame-functions #'hyperb:window-sys-term t)
;;; ************************************************************************
diff --git a/hvm.el b/hvm.el
index 8351d0e..0947c8f 100644
--- a/hvm.el
+++ b/hvm.el
@@ -60,7 +60,7 @@
(defun vm-edit-mode ()
"Major mode for editing vm mail messages.
- Special commands:\\{vm-edit-message-map}
+Special commands:\\{vm-edit-message-map}
Turning on vm-edit-mode calls the value of the variable vm-edit-message-hook,
if that value is non-nil."
(interactive)
@@ -75,7 +75,7 @@ if that value is non-nil."
;;;###autoload
(defun Vm-init ()
- "Initializes Hyperbole support for Vm mail reading."
+ "Initialize Hyperbole support for Vm mail reading."
(interactive)
(setq hmail:composer 'mail-mode
hmail:lister 'vm-summary-mode
@@ -119,7 +119,7 @@ This includes Hyperbole button data."
(defun Vm-msg-next () (vm-next-message 1))
(defun Vm-msg-num ()
- "Returns number of vm mail message that point is within, in physical message
order."
+ "Return number of vm mail message that point is within, in physical message
order."
(interactive)
(let ((count 1)
(case-fold-search))
@@ -133,8 +133,8 @@ This includes Hyperbole button data."
(defun Vm-msg-prev () (vm-previous-message 1))
(defun Vm-msg-to-p (mail-msg-id mail-file)
- "Sets current buffer to start of msg with MAIL-MSG-ID in MAIL-FILE.
-Returns t if successful, else nil or signals error."
+ "Set current buffer to start of msg with MAIL-MSG-ID in MAIL-FILE.
+Return t if successful, else nil or signal error."
(if (not (file-readable-p mail-file))
nil
(vm-visit-folder mail-file)
@@ -156,7 +156,7 @@ Returns t if successful, else nil or signals error."
(narrow-to-region (point-min) (Vm-msg-end))))
(defun Vm-to ()
- "Sets current buffer to a mail reader buffer."
+ "Set current buffer to a mail reader buffer."
(and (eq major-mode 'vm-summary-mode) (set-buffer vm-mail-buffer)))
(defun Vm-Summ-delete ()
@@ -168,7 +168,7 @@ Returns t if successful, else nil or signals error."
(defalias 'Vm-Summ-goto 'vm-follow-summary-cursor)
(defun Vm-Summ-to ()
- "Sets current buffer to a mail listing buffer."
+ "Set current buffer to a mail listing buffer."
(and (eq major-mode 'vm-mode) (set-buffer vm-summary-buffer)))
(defun Vm-Summ-undelete-all ()
@@ -180,7 +180,7 @@ Returns t if successful, else nil or signals error."
;;; ************************************************************************
(defun Vm-msg-end ()
- "Returns end point for current Vm message, including Hyperbole button data.
+ "Return end point for current Vm message, including Hyperbole button data.
Has side-effect of widening buffer."
(save-excursion
(goto-char (point-min))
@@ -279,9 +279,9 @@ Has side-effect of widening buffer."
"End the edit of a message and copy the result to its folder."
(interactive)
(if (null vm-message-pointer)
- (error "This is not a VM message edit buffer."))
+ (error "This is not a VM message edit buffer"))
(if (null (buffer-name (vm-buffer-of (car vm-message-pointer))))
- (error "The folder buffer for this message has been killed."))
+ (error "The folder buffer for this message has been killed"))
(let ((pos-offset (- (point) (point-min))))
;; make sure the message ends with a newline
(goto-char (point-max))
@@ -316,7 +316,7 @@ Has side-effect of widening buffer."
(widen)
(with-current-buffer (vm-buffer-of (vm-real-message-of (car mp)))
(if (not (memq (vm-real-message-of (car mp)) vm-message-list))
- (error "The original copy of this message has been
expunged."))
+ (error "The original copy of this message has been expunged"))
(vm-save-restriction
(widen)
(goto-char (vm-headers-of (vm-real-message-of (car mp))))
@@ -372,7 +372,7 @@ Has side-effect of widening buffer."
;;; Define this function if the VM version in use doesn't have it.
(or (fboundp 'vm-goto-message-at-point)
(defun vm-goto-message-at-point ()
- "In a VM folder buffer, select the message that contains point."
+ "In a VM folder buffer, select the message that contain point."
(cond ((fboundp 'vm-update-search-position)
(vm-update-search-position t)
;; vm-show-current-message only adjusts (point-max),
diff --git a/hycontrol.el b/hycontrol.el
index d429b57..523f82b 100644
--- a/hycontrol.el
+++ b/hycontrol.el
@@ -25,7 +25,7 @@
;;
;; HyControl is invoked via either of two global minor modes under
;; the Hyperbole screen menu, both of which can toggle to the other
-;; by pressing {t}. `hycontrol-enable-frames-mode' bound to {C-h h s
+;; by pressing {t}. `hycontrol-enable-frames-mode' bound to {C-h h s
;; f} manages visible frame creation, deletion, sizing, position and
;; face zooming (enlarging and shrinking); if called interactively,
;; it stores the current frame configuration for restoration via a
@@ -225,7 +225,7 @@ The final predicate should always be t, for default values,
typically of zero.")
0.75 and 75 are treated as the same percentage.")
(defvar hycontrol-arg nil
- "HyControl copy of prefix-arg that it changes within key bindings.
+ "HyControl copy of `prefix-arg' that it changes within key bindings.
`pre-command-hook' synchronizes this value to `prefix-arg'.")
;;; Frame Keys
@@ -436,8 +436,8 @@ The final predicate should always be t, for default values,
typically of zero.")
"@=grid of wins, f/F=clone/move win to new frame,
-/+=minimize/maximize frame, ==frames same size, u/b/~=un/bury/swap bufs\n"
"Frame to edges: c=cycle, i/j/k/m=expand/contract, p/num-keypad=move;
z/Z=zoom out/in, t=to WINDOWS mode, q=quit")
"HyControl frames-mode minibuffer prompt string to pass to format.
-Format it with 2 arguments: prefix-arg and a plural string indicating if
-prefix-arg is not equal to 1.")
+Format it with 2 arguments: `prefix-arg' and a plural string indicating if
+`prefix-arg' is not equal to 1.")
(defvar hycontrol--windows-prompt-format
(concat
@@ -446,8 +446,8 @@ prefix-arg is not equal to 1.")
"@=grid of wins, f/F=clone/move win to new frame, -/+=minimize/maximize
win, ==wins same size, u/b/~=un/bury/swap bufs\n"
"Frame to edges: c=cycle, i/j/k/m=expand/contract, p/num-keypad=move;
z/Z=zoom out/in, t=to FRAMES mode, q=quit")
"HyControl windows-mode minibuffer prompt string to pass to format.
-Format it with 2 arguments: prefix-arg and a plural string indicating if
-prefix-arg is not equal to 1.")
+Format it with 2 arguments: `prefix-arg' and a plural string indicating if
+`prefix-arg' is not equal to 1.")
(defvar hycontrol--prompt-format nil
"The current HyControl mode help format string or nil if not active.")
@@ -459,10 +459,10 @@ associated key: quit {q}, abort {C-g}, or toggle {t}.")
(defvar hycontrol--fconfig nil
- "Used to store a frame configuration while in hycontrol")
+ "Used to store a frame configuration while in hycontrol.")
(defvar hycontrol--wconfig nil
- "Used to store a window configuration while in hycontrol")
+ "Used to store a window configuration while in hycontrol.")
(defvar hycontrol--invert-display-buffer-predicates nil)
@@ -862,7 +862,7 @@ is set to 1. If it is > `hycontrol-maximum-units', it is
set to
(defun hycontrol-quit-frames-mode ()
"Globally quit HyControl Frames mode, typically on a press of {q}.
-If in a help buffer where {q} is bound to quit-window, run that
+If in a help buffer where {q} is bound to `quit-window', run that
instead of quitting HyControl. Use {Q} to always quit from HyControl."
(interactive)
;; Allow for quitting from help windows displayed when HyControl is active.
@@ -874,7 +874,7 @@ instead of quitting HyControl. Use {Q} to always quit from
HyControl."
(defun hycontrol-quit-windows-mode ()
"Globally quit HyControl Windows mode, typically on a press of {q}.
-If in a help buffer where {q} is bound to quit-window, run that
+If in a help buffer where {q} is bound to `quit-window', run that
instead of quitting HyControl. Use {Q} to always quit from HyControl."
(interactive)
;; Allow for quitting from help windows displayed when HyControl is active.
@@ -973,7 +973,7 @@ nothing and return nil."
(defun hycontrol-frame-to-screen-edges (&optional arg)
"Cycle the selected frame's position clockwise through the middle of edges
and corners of the screen; once per call.
-With an optional arg of 0, just reset the cycle position to 0."
+With an optional ARG of 0, just reset the cycle position to 0."
(interactive)
(if (and arg (zerop arg))
(setq hycontrol--screen-edge-position 0)
@@ -1029,7 +1029,7 @@ Accepts optional arguments FRAME, X-ORIGIN, and Y-ORIGIN
(in pixels) to use when
;; Ensure entire frame is positioned onscreen, keeping the
;; original frame origin coordinates if possible.
(set-frame-position frame
- (min (max 0 x-origin)
+ (min (max 0 x-origin)
(- (display-pixel-width) (hycontrol-frame-width
frame) hycontrol-screen-right-offset))
(min (max 0 y-origin)
(- (display-pixel-height) (hycontrol-frame-height
frame) hycontrol-screen-bottom-offset)))
diff --git a/hypb.el b/hypb.el
index 29b11b1..d1ec61f 100644
--- a/hypb.el
+++ b/hypb.el
@@ -42,7 +42,7 @@ It must end with a space."
;;; ************************************************************************
(defun hypb:call-process-p (program &optional infile predicate &rest args)
- "Calls an external PROGRAM with INFILE for input.
+ "Call an external PROGRAM with INFILE for input.
If PREDICATE is given, it is evaluated in a buffer with the PROGRAM's
output and the result returned. If PREDICATE is nil, returns t iff
program has no output or just a 0-valued output.
@@ -53,7 +53,7 @@ Rest of ARGS are passed as arguments to PROGRAM."
(setq buffer-read-only nil)
(erase-buffer)
(apply 'call-process program infile buf nil args)
- (setq found
+ (setq found
(if predicate
(eval predicate)
(or (= (point-max) 1) ;; No output, consider cmd a success.
@@ -73,7 +73,7 @@ Rest of ARGS are passed as arguments to PROGRAM."
c))
(defun hypb:chmod (op octal-permissions file)
- "Uses OP and OCTAL-PERMISSIONS integer to set FILE permissions.
+ "Use OP and OCTAL-PERMISSIONS integer to set FILE permissions.
OP may be +, -, xor, or default =."
(let ((func (cond ((eq op '+) #'logior)
((eq op '-) (lambda (p1 p2) (logand (lognot p1) p2)))
@@ -83,7 +83,7 @@ OP may be +, -, xor, or default =."
(file-modes file)))))
(defun hypb:cmd-key-string (cmd-sym &optional keymap)
- "Returns a single pretty printed key sequence string bound to CMD-SYM.
+ "Return a single pretty printed key sequence string bound to CMD-SYM.
Global keymap is used unless optional KEYMAP is given."
(if (and cmd-sym (symbolp cmd-sym) (fboundp cmd-sym))
(let* ((get-keys (lambda (cmd-sym keymap)
@@ -96,7 +96,7 @@ Global keymap is used unless optional KEYMAP is given."
" " (symbol-name cmd-sym) " RET")
keys)
"}"))
- (error "(hypb:cmd-key-string): Invalid cmd-sym arg: %s." cmd-sym)))
+ (error "(hypb:cmd-key-string): Invalid cmd-sym arg: %s" cmd-sym)))
;;;###autoload
(defun hypb:configuration (&optional out-buf)
@@ -148,7 +148,7 @@ Global keymap is used unless optional KEYMAP is given."
(untabify start (point)))))
(defun hypb:debug ()
- "Loads Hyperbole hbut.el source file and sets debugging traceback flag."
+ "Load Hyperbole hbut.el source file and set debugging traceback flag."
(interactive)
(or (featurep 'hinit) (load "hyperbole"))
(or (and (featurep 'hbut)
@@ -186,7 +186,7 @@ Global keymap is used unless optional KEYMAP is given."
string)))
(defun hypb:domain-name ()
- "Returns current Internet domain name with '@' prepended or nil if none."
+ "Return current Internet domain name with '@' prepended or nil if none."
(let* ((dname-cmd (or (file-exists-p "/usr/bin/domainname")
(file-exists-p "/bin/domainname")))
(dname (or (and (boundp 'message-user-fqdn) (stringp message-user-fqdn)
@@ -195,7 +195,7 @@ Global keymap is used unless optional KEYMAP is given."
(getenv "DOMAINNAME")
(if dname-cmd
(hypb:call-process-p
- "domainname" nil
+ "domainname" nil
'(substring (buffer-string) 0 -1)))))
host-and-domain)
(if (or (and dname (string-match "\\." dname))
@@ -241,7 +241,7 @@ FILE is temporarily read into a buffer to determine the
major mode if necessary.
(kill-buffer buf)))))
(defun hypb:format-quote (arg)
- "Replace all single % with %% in any string ARG so that a call to `format'
or `message' ignores them.
+ "Replace all single % with %% in any string ARG so that a call to `format'
or `message' ignore them.
Return either the modified string or the original ARG."
(if (stringp arg)
(replace-regexp-in-string
@@ -252,11 +252,11 @@ Return either the modified string or the original ARG."
arg))
(defun hypb:function-copy (func-symbol)
- "Copies FUNC-SYMBOL's body for overloading. Returns copy of body."
+ "Copy FUNC-SYMBOL's body for overloading. Return copy of body."
(if (fboundp func-symbol)
(let ((func (hypb:indirect-function func-symbol)))
(cond ((listp func) (copy-sequence func))
- ((subrp func) (error "(hypb:function-copy): `%s' is a primitive;
can't copy body."
+ ((subrp func) (error "(hypb:function-copy): `%s' is a primitive;
can't copy body"
func-symbol))
((and (hypb:emacs-byte-code-p func) (fboundp 'make-byte-code))
(if (not (fboundp 'compiled-function-arglist))
@@ -275,7 +275,7 @@ Return either the modified string or the original ARG."
(setq new-code (nconc new-code (list (nth 1 spec)))))
(apply 'make-byte-code new-code))))
(t (error "(hypb:function-copy): Can't copy function body: %s"
func))))
- (error "(hypb:function-copy): `%s' symbol is not bound to a function."
+ (error "(hypb:function-copy): `%s' symbol is not bound to a function"
func-symbol)))
(defun hypb:function-overload (func-sym prepend &rest new-forms)
@@ -305,7 +305,7 @@ Return either the modified string or the original ARG."
(append old-func-call new-forms)))))))
(defun hypb:function-symbol-replace (func-sym sym-to-replace replace-with-sym)
- "Replaces in body of FUNC-SYM SYM-TO-REPLACE with REPLACE-WITH-SYM.
+ "Replace in body of FUNC-SYM SYM-TO-REPLACE with REPLACE-WITH-SYM.
FUNC-SYM may be a function symbol or its body. All occurrences within lists
are replaced. Returns body of modified FUNC-SYM."
(let ((body (hypb:indirect-function func-sym))
@@ -364,7 +364,7 @@ If MARKER is invalid signal an error."
(switch-to-buffer buffer)))))
(defun hypb:help-buf-name (&optional suffix)
- "Returns a Hyperbole help buffer name for current buffer.
+ "Return a Hyperbole help buffer name for current buffer.
With optional SUFFIX string, uses it rather than buffer name."
(let ((bn (or suffix (buffer-name))))
(if (string-match (regexp-quote hypb:help-buf-prefix) bn)
@@ -421,7 +421,7 @@ copied, otherwise, it is omitted."
;;;###autoload
(defun hypb:locate (search-string &optional filter arg)
- "Find file name matches anywhere, calling the value of `locate-command', and
putting results in the `*Locate*' buffer.
+ "Find file name match anywhere, calling the value of `locate-command', and
putting results in the `*Locate*' buffer.
Pass it SEARCH-STRING as argument. Interactively, prompt for SEARCH-STRING.
With prefix arg ARG, prompt for the exact shell command to run instead.
@@ -456,18 +456,18 @@ then `locate-post-command-hook'."
(defun hypb:mark-marker (inactive-p)
"Return this buffer's mark as a marker object, or nil if no mark.
INACTIVE-P is unused, it is for compatibility with XEmacs' version of
-mark-marker."
+`mark-marker'."
(mark-marker))
;;;###autoload
(defun hypb:map-plist (func plist)
- "Returns result of applying FUNC of two args, key and value, to key-value
pairs in PLIST, a property list."
+ "Return result of applying FUNC of two args, key and value, to key-value
pairs in PLIST, a property list."
(cl-loop for (k v) on plist by #'cddr
collect (funcall func k v) into result
finally return result))
(defun hypb:map-sublists (func list)
- "Applies FUNC to every atom found at any level of LIST.
+ "Apply FUNC to every atom found at any level of LIST.
FUNC must take two arguments, an atom and a list in which the atom is found.
Returns values from applications of FUNC as a list with the same
structure as LIST. FUNC is therefore normally used just for its side-effects."
@@ -478,10 +478,10 @@ structure as LIST. FUNC is therefore normally used just
for its side-effects."
list))
(defun hypb:map-vector (func object)
- "Returns list of results of application of FUNC to each element of OBJECT.
-OBJECT should be a vector or byte-code object."
+ "Return list of results of application of FUNC to each element of OBJECT.
+OBJECT should be a vector or `byte-code' object."
(if (not (or (vectorp object) (hypb:emacs-byte-code-p object)))
- (error "(hypb:map-vector): Second argument must be a vector or byte-code
object."))
+ (error "(hypb:map-vector): Second argument must be a vector or byte-code
object"))
(let ((end (length object))
(i 0)
(result))
@@ -505,7 +505,7 @@ WINDOW pixelwise."
nil nil window-resize-pixelwise))
(defun hypb:replace-match-string (regexp str newtext &optional literal)
- "Replaces all matches for REGEXP in STR with NEWTEXT string and returns the
result.
+ "Replace all matches for REGEXP in STR with NEWTEXT string and return the
result.
Optional LITERAL non-nil means do a literal replacement.
Otherwise treat \\ in NEWTEXT string as special:
\\& means substitute original matched text,
@@ -560,7 +560,7 @@ that returns a replacement string."
(concat rtn-str (substring str start))))
(defun hypb:return-process-output (program &optional infile &rest args)
- "Returns as a string the output from external PROGRAM with INFILE for input.
+ "Return as a string the output from external PROGRAM with INFILE for input.
Rest of ARGS are passed as arguments to PROGRAM.
Removes any trailing newline at the end of the output."
(let ((buf (get-buffer-create "*test-output*"))
@@ -577,7 +577,7 @@ Removes any trailing newline at the end of the output."
output))
(defun hypb:remove-lines (regexp)
- "Remove lines containing matches for REGEXP within the active region or to
the end of buffer."
+ "Remove lines containing match for REGEXP within the active region or to the
end of buffer."
(interactive "sRemove lines with match for regexp: ")
(flush-lines regexp nil nil t))
@@ -618,7 +618,7 @@ If in an Emacs Lisp mode buffer and no PREFIX-ARG is given,
limit search to only
(grep grep-cmd)))
(defun hypb:save-lines (regexp)
- "Save only lines containing matches for REGEXP within the active region or to
the end of buffer."
+ "Save only lines containing match for REGEXP within the active region or to
the end of buffer."
(interactive "sSave lines with match for regexp: ")
(keep-lines regexp nil nil t))
@@ -637,7 +637,7 @@ The value returned is the value of the last form in BODY."
(error "(hypb:select-window-frame): Argument must be a live window, not
'%s'" window)))
(defun hypb:supercite-p ()
- "Returns non-nil iff the Emacs add-on supercite package is in use."
+ "Return non-nil iff the Emacs add-on supercite package is in use."
(let (hook-val)
(if (memq t (mapcar
(lambda (hook-var)
@@ -655,7 +655,7 @@ The value returned is the value of the last form in BODY."
This determines whether to search inside invisible text or not.
Toggles the variable ‘isearch-invisible’ between values
nil and a non-nil value of the option ‘search-invisible’
-(or ‘open’ if ‘search-invisible’ is nil).
+\(or ‘open’ if ‘search-invisible’ is nil).
With optional prefix ARG > 0, turn on searching invisible text.
If ARG <= 0, turn search only visible text."
@@ -676,7 +676,7 @@ If ARG <= 0, turn search only visible text."
(user-login-name)))
(defun hypb:window-list (&optional minibuffer-flag)
- "Returns a list of Lisp window objects for all Emacs windows in selected
frame.
+ "Return a list of Lisp window objects for all Emacs windows in selected
frame.
Optional first arg MINIBUFFER-FLAG t means include the minibuffer window
in the list, even if it is not active. If MINIBUFFER-FLAG is neither t
nor nil it means to not count the minibuffer window even if it is active."
@@ -687,7 +687,7 @@ nor nil it means to not count the minibuffer window even if
it is active."
;;; ************************************************************************
(defvar hypb:home-page "https://www.gnu.org/software/hyperbole/";
- "The web home page for Hyperbole")
+ "The web home page for Hyperbole.")
(defvar hypb:hyperbole-banner-keymap
(let ((map (make-sparse-keymap)))
@@ -774,7 +774,7 @@ Without file, the banner is prepended to the current
buffer."
(buffer-substring-no-properties (point)
(point-max)))))
(defun hypb:oct-to-int (oct-num)
- "Returns octal integer OCTAL-NUM converted to a decimal integer."
+ "Return octal integer OCT-NUM converted to a decimal integer."
(let ((oct-str (int-to-string oct-num))
(dec-num 0))
(and (string-match "[^0-7]" oct-str)
diff --git a/hyperbole.el b/hyperbole.el
index 534a5a3..721d735 100644
--- a/hyperbole.el
+++ b/hyperbole.el
@@ -39,11 +39,11 @@
;;
;; 3. Build outlines with multi-level numbered outline nodes, e.g. 1.4.8.6,
;; that all renumber automatically as any node or tree is moved in the
-;; outline. Each node also has a permanent hyperlink anchor that you can
+;; outline. Each node also has a permanent hyperlink anchor that you can
;; reference from any other node;
;;
;; 4. Manage all your contacts quickly with hierarchical categories and embed
-;; hyperlinks within each entry. Or create an archive of documents with
+;; hyperlinks within each entry. Or create an archive of documents with
;; hierarchical entries and use the same search mechanism to quickly find any
;; matching entry;
;;
@@ -54,7 +54,7 @@
;; major web search engines with the touch of a few keys.
;;
;; The common thread in all these features is making retrieval, management and
-;; display of information fast and easy. That is Hyperbole's purpose.
+;; display of information fast and easy. That is Hyperbole's purpose.
;;
;; ----
;;
@@ -74,7 +74,7 @@
;;; ************************************************************************
(defconst hyperbole-loading t
- "Temporary constant available for testing while Hyperbole is loading.")
+ "Temporary constant available for testing while Hyperbole is loading.")
;; Ensure defgroup and defcustom are defined for use throughout Hyperbole.
(require 'custom)
@@ -119,7 +119,7 @@
"hversion"
(file-name-directory load-file-name))
t)))
- (error "(Hyperbole): Startup failure: `hyperb:dir' must be manually added
to `load-path' to fix.")))
+ (error "(Hyperbole): Startup failure: `hyperb:dir' must be manually added
to `load-path' to fix")))
;; This must be defined before the defcustom `inhbit-hyperbole-messaging'.
;;;###autoload
@@ -199,7 +199,7 @@ See `hkey-binding-entry' for format.")
See `hkey-binding-entry' for format.")
(defun hkey-binding-entry (key)
- "Given an Emacs KEY that may be bound, returns an entry to save the
associated binding.
+ "Given an Emacs KEY that may be bound, return an entry to save the
associated binding.
Entry format is: (key-description key-sequence key-binding)."
(list (key-description key) key (key-binding key)))
@@ -207,7 +207,7 @@ Entry format is: (key-description key-sequence
key-binding)."
(mapcar #'cadr entries))
(defun hkey-get-bindings ()
- "Returns a list of entries for storage of Hyperbole key bindings.
+ "Return a list of entries for storage of Hyperbole key bindings.
`hkey-initialize' must have already been called or the list will be empty."
(mapcar (lambda (key) (hkey-binding-entry key))
(hkey-bindings-keys hkey-previous-bindings)))
@@ -311,7 +311,7 @@ bindings after load)."
(global-set-key (cadr key-and-binding) (car (cddr key-and-binding)))))
(defun hyperbole-toggle-bindings ()
- "Toggles between Hyperbole mouse and keyboard keys and their prior bindings."
+ "Toggle between Hyperbole mouse and keyboard keys and their prior bindings."
(interactive)
(let ((key-binding-list (if hkey-bindings-flag
hkey-previous-bindings
@@ -328,7 +328,7 @@ bindings after load)."
(if (called-interactively-p 'interactive)
(message "%s mouse and keyboard bindings are now in use."
(if hkey-bindings-flag "Hyperbole" "Non-Hyperbole"))))
- (error "(hyperbole-toggle-bindings): `%s' is empty."
+ (error "(hyperbole-toggle-bindings): `%s' is empty"
(if hkey-bindings-flag 'hkey-previous-bindings 'hkey-bindings)))))
;;; ************************************************************************
@@ -456,7 +456,7 @@ With optional ARG, override them iff ARG is positive."
;; the Hyperbole package is activated in an Emacs session.
;;;###autoload (load "kotl/kotl-autoloads" nil 'nowarn)
-;; Before the 6.0.1 release, Hyperbole used to patch the
package-generate-autoloads
+;; Before the 6.0.1 release, Hyperbole used to patch the
package-generate-autoloads
;; function to ensure that kotl/ subdirectories were autoloaded. This
;; is no longer used but is left here temporarily for reference.
;;
@@ -698,7 +698,7 @@ If FLAG is nil then text is shown, while if FLAG is t the
text is hidden."
(hkey-install-override-local-bindings)
(add-hook 'after-load-alist '(hyperbole
hkey-install-override-local-bindings)))
;;
- ;; Hyperbole initialization is complete.
+ ;; Hyperbole initialization is complete.
(message "Initializing Hyperbole...done")
(message "Hyperbole %s is ready for action." hyperb:version))
diff --git a/hyrolo-demo.el b/hyrolo-demo.el
index 626f372..96b03ba 100644
--- a/hyrolo-demo.el
+++ b/hyrolo-demo.el
@@ -9,6 +9,8 @@
;;
;; This file is part of GNU Hyperbole.
+;;; Commentary:
+
;;; Code:
;;; ************************************************************************
@@ -87,3 +89,4 @@ single argument."
(global-set-key "\C-x4r" 'hyrolo-demo-fgrep)
(provide 'hyrolo-demo)
+;;; hyrolo-demo.el ends here
diff --git a/hyrolo-logic.el b/hyrolo-logic.el
index da0d0be..c3a021c 100644
--- a/hyrolo-logic.el
+++ b/hyrolo-logic.el
@@ -30,7 +30,7 @@
;; words as a single argument.
;;
;; 2. Logical `hyrolo-and', `hyrolo-or', `hyrolo-not', and `hyrolo-xor' rolo
-;; entry string filter functions. They take any number of string or
+;; entry string filter functions. They take any number of string or
;; boolean arguments and may be nested. NOTE THAT THESE FUNCTIONS
;; SHOULD NEVER BE CALLED DIRECTLY UNLESS THE FREE VARIABLES `start'
;; and `end' ARE BOUND BEFOREHAND.
@@ -187,7 +187,7 @@ of applications of SEXP that matched entries."
curr-entry-level (buffer-substring start end-entry-hdr)
end (hyrolo-to-entry-end include-sub-entries
curr-entry-level))
(let ((result (eval sexp)))
- (or count-only
+ (or count-only
(and result (= num-found 0) hdr-pos
(let* ((src (or (buffer-file-name hyrolo-buf)
hyrolo-buf))
diff --git a/hyrolo.el b/hyrolo.el
index cdd3937..b51f0d5 100644
--- a/hyrolo.el
+++ b/hyrolo.el
@@ -73,13 +73,13 @@ executable must be found as well (for Oauth security)."
(defun hyrolo-google-contacts-p ()
"Return non-nil if `hyrolo-google-contacts-flag' is non-nil and
google-contacts package and gpg executables are available for use."
(and hyrolo-google-contacts-flag
- (featurep 'google-contacts)
+ (featurep 'google-contacts)
;; If no gpg encryption executable, Oauth login to Google will fail.
(or (executable-find "gpg2") (executable-find "gpg"))))
;;;###autoload
(defun hyrolo-initialize-file-list ()
- "Initialize the list of files used for HyRolo searches."
+ "Initialize the list of files used for HyRolo search."
(interactive)
(let* ((gcontacts (if (hyrolo-google-contacts-p)
google-contacts-buffer-name))
(ms "c:/_rolo.otl")
@@ -145,7 +145,7 @@ Default value is nil, meaning no reformmating is done.")
;;;###autoload
(defun hyrolo-add (name &optional file)
- "Adds a new entry in personal rolo for NAME.
+ "Add a new entry in personal rolo for NAME.
Last name first is best, e.g. \"Smith, John\".
With prefix argument, prompts for optional FILE to add entry within.
NAME may be of the form: parent/child to insert child below a parent
@@ -185,7 +185,7 @@ entry which begins with the parent string."
(if (re-search-forward
(concat hyrolo-entry-regexp (regexp-quote parent)) nil t)
(setq level (match-string-no-properties hyrolo-entry-group-number))
- (error "(hyrolo-add): `%s' category not found in \"%s\"."
+ (error "(hyrolo-add): `%s' category not found in \"%s\""
parent file)))
(narrow-to-region (point)
(progn (hyrolo-to-entry-end t level) (point)))
@@ -264,7 +264,7 @@ Second arg RETURN-TO-BUFFER is the buffer to leave point
within after the displa
(interactive)
(or display-buf (setq display-buf (get-buffer hyrolo-display-buffer)))
(if display-buf nil
- (error "(hyrolo-display-matches): Search the rolo first."))
+ (error "(hyrolo-display-matches): Search the rolo first"))
;; Save current window configuration if rolo match buffer is not
;; displayed in one of the windows already.
(or
@@ -338,13 +338,13 @@ Returns entry name if found, else nil."
(progn (setq src (hbut:key-src))
(cond ((and (boundp 'bbdb-file) (stringp bbdb-file) (equal src
(expand-file-name bbdb-file)))
;; For now, can't edit an entry from the bbdb database,
signal an error.
- (error "(hyrolo-edit-entry): BBDB entries are not
editable."))
+ (error "(hyrolo-edit-entry): BBDB entries are not
editable"))
((and (featurep 'google-contacts) (equal src (get-buffer
google-contacts-buffer-name)))
;; For now, can't edit an entry from Google Contacts,
signal an error.
- (error "(hyrolo-edit-entry): Google Contacts entries are
not editable."))
+ (error "(hyrolo-edit-entry): Google Contacts entries are
not editable"))
(t (hyrolo-edit name src)
name)))
- (error "(hyrolo-edit-entry): Move to an entry to edit it."))))
+ (error "(hyrolo-edit-entry): Move to an entry to edit it"))))
;;;###autoload
(defun hyrolo-fgrep (string &optional max-matches hyrolo-file count-only
no-display)
@@ -466,7 +466,7 @@ search for the current match string rather than regular
expression."
;;;###autoload
(defun hyrolo-kill (name &optional file)
- "Kills a rolo entry given by NAME within `hyrolo-file-list'.
+ "Kill a rolo entry given by NAME within `hyrolo-file-list'.
With prefix argument, prompts for optional FILE to locate entry within.
NAME may be of the form: parent/child to kill child below a parent entry
which begins with the parent string.
@@ -505,7 +505,7 @@ Returns t if entry is killed, nil otherwise."
(point)
(min (+ (point) 60)
(progn (end-of-line) (point))))))
- (if (y-or-n-p (format "Kill `%s...' " entry-line))
+ (if (y-or-n-p (format "Kill `%s...'? " entry-line))
(progn
(funcall kill-op start level)
(message "Killed"))
@@ -620,9 +620,9 @@ XEmacs only."
;;;###autoload
(defun hyrolo-sort (&optional hyrolo-file)
- "Sorts up to 14 levels of entries in HYROLO-FILE (default is personal rolo).
+ "Sort up to 14 levels of entries in HYROLO-FILE (default is personal rolo).
Assumes entries are delimited by one or more `*'characters.
-Returns list of number of groupings at each entry level."
+Returns list of number of groupings at each entry level."
(interactive
(list (let ((default "")
(file))
@@ -658,7 +658,7 @@ Returns list of number of groupings at each entry level."
entries-per-level-list))
(defun hyrolo-sort-level (hyrolo-file level-regexp &optional max-groupings)
- "Sorts groupings of entries in HYROLO-FILE at hierarchy level LEVEL-REGEXP.
+ "Sort groupings of entries in HYROLO-FILE at hierarchy level LEVEL-REGEXP.
To a maximum of optional MAX-GROUPINGS. Nil value of MAX-GROUPINGS means all
groupings at the given level. LEVEL-REGEXP should simply match the text of
any rolo entry of the given level, not the beginning of a line (^); an
@@ -729,14 +729,14 @@ Useful when bound to a mouse key."
(goto-char (point-min)))
(defun hyrolo-top-level ()
- "Show only the first line of all top-level rolo matches."
+ "Show only the first line of all `top-level' rolo matches."
(interactive)
(hyrolo-verify)
(hyrolo-show-levels 1))
;;;###autoload
(defun hyrolo-word (string &optional max-matches hyrolo-file count-only
no-display)
- "Display rolo entries with whole word matches for STRING.
+ "Display rolo entries with whole word match for STRING.
To a maximum of optional prefix arg MAX-MATCHES, in file(s) from optional
HYROLO-FILE or hyrolo-file-list. Default is to find all matching entries.
Each
entry is displayed with all of its sub-entries. Optional COUNT-ONLY non-nil
@@ -761,7 +761,7 @@ hyrolo-file-list."
;;;###autoload
(defun hyrolo-yank (name &optional regexp-p)
- "Inserts at point the first rolo entry matching NAME.
+ "Insert at point the first rolo entry matching NAME.
With optional prefix arg, REGEXP-P, treats NAME as a regular expression instead
of a string."
(interactive "sInsert rolo entry named: \nP")
@@ -1186,8 +1186,8 @@ level two. Returns number of groupings matched."
(set-buffer hyrolo-buf)))
(defun hyrolo-buffer-exists-p (hyrolo-buf)
- "Returns buffer given by HYROLO-BUF or nil.
-HYROLO-BUF may be a file-name, buffer-name, or buffer."
+ "Return buffer given by HYROLO-BUF or nil.
+HYROLO-BUF may be a file-name, `buffer-name', or buffer."
(car (memq (get-buffer (or (and (stringp hyrolo-buf)
(get-file-buffer hyrolo-buf))
hyrolo-buf))
@@ -1224,7 +1224,7 @@ HYROLO-BUF may be a file-name, buffer-name, or buffer."
hproperty:highlight-face)))))))
(defun hyrolo-isearch-for-regexp (regexp)
- "Interactively search forward for the next occurrence of current match
regexp.
+ "Interactively search forward for the next occurrence of current match
REGEXP.
Then add characters to further narrow the search."
(hyrolo-verify)
(if (stringp regexp)
@@ -1234,14 +1234,14 @@ Then add characters to further narrow the search."
(isearch-forward-regexp)))
(defun hyrolo-kill-buffer (&optional hyrolo-buf)
- "Kills optional HYROLO-BUF if unchanged and `hyrolo-kill-buffers-after-use'
is t.
+ "Kill optional HYROLO-BUF if unchanged and `hyrolo-kill-buffers-after-use'
is t.
Default is current buffer."
(or hyrolo-buf (setq hyrolo-buf (current-buffer)))
(and hyrolo-kill-buffers-after-use (not (buffer-modified-p hyrolo-buf))
(kill-buffer hyrolo-buf)))
(defun hyrolo-name-and-email ()
- "If point is in a mail message, returns list of (name email-addr) of sender.
+ "If point is in a mail message, return list of (name email-addr) of sender.
Name is returned as `last, first-and-middle'."
(let ((email) (name) (from))
(save-window-excursion
@@ -1276,7 +1276,7 @@ Name is returned as `last, first-and-middle'."
(list name email))))
(defun hyrolo-name-at ()
- "If point is within an entry in `hyrolo-display-buffer', returns the entry
name, else nil."
+ "If point is within an entry in `hyrolo-display-buffer', return the entry
name, else nil."
(if (string-equal (buffer-name) hyrolo-display-buffer)
(save-excursion
(if (or (looking-at hyrolo-entry-regexp)
@@ -1292,7 +1292,7 @@ Name is returned as `last, first-and-middle'."
(or (/= (point-min) 1) (/= (1+ (buffer-size)) (point-max))))
(defun hyrolo-save-buffer (&optional hyrolo-buf)
- "Saves optional HYROLO-BUF if changed and `hyrolo-save-buffers-after-use' is
t.
+ "Save optional HYROLO-BUF if changed and `hyrolo-save-buffers-after-use' is
t.
Default is current buffer. Used, for example, after a rolo entry is killed."
(or hyrolo-buf (setq hyrolo-buf (current-buffer)))
(and hyrolo-save-buffers-after-use (buffer-modified-p hyrolo-buf)
@@ -1345,13 +1345,13 @@ a default of MM/DD/YYYY."
(and (>= lines 0)
(/= desired-shrinkage 0)
(> (frame-height) (1+ height))
- (shrink-window
+ (shrink-window
(if (< desired-shrinkage 0)
(max desired-shrinkage (- height (/ (frame-height) 2)))
(min desired-shrinkage (- height window-min-height)))))))
(defun hyrolo-to (name &optional file-list)
- "Moves point to entry for NAME within optional FILE-LIST.
+ "Move point to entry for NAME within optional FILE-LIST.
`hyrolo-file-list' is used as default when FILE-LIST is nil.
Leaves point immediately after match for NAME within entry.
Switches internal current buffer but does not alter the frame.
@@ -1384,7 +1384,7 @@ Returns point where matching entry begins or nil if not
found."
(t ;; Found parent but not child
(setq buffer-read-only nil)
(hyrolo-to-buffer (current-buffer))
- (error "(hyrolo-to): `%s' part of name not found in \"%s\"."
+ (error "(hyrolo-to): `%s' part of name not found in \"%s\""
parent file)))
(if level
(narrow-to-region (point)
@@ -1407,7 +1407,7 @@ Returns point where matching entry begins or nil if not
found."
(pop-to-buffer buffer other-window-flag))
(defun hyrolo-to-entry-end (&optional include-sub-entries curr-entry-level)
- "Moves point to the end of the whole entry that point is within if optional
INCLUDE-SUB-ENTRIES is non-nil.
+ "Move point to the end of the whole entry that point is within if optional
INCLUDE-SUB-ENTRIES is non-nil.
CURR-ENTRY-LEVEL is a string whose length is the same as the last found entry
header. If INCLUDE-SUB-ENTRIES is nil, CURR-ENTRY-LEVEL is not needed.
Returns current point."
diff --git a/hywconfig.el b/hywconfig.el
index 983a6f3..bd5e09d 100644
--- a/hywconfig.el
+++ b/hywconfig.el
@@ -16,7 +16,7 @@
;; specific frame). The first way associates a name with each
;; stored window configuration. The name can then be used to
;; retrieve the window configuration later. The following functions
-;; provide this behavior:
+;; provide this behavior:
;;
;; hywconfig-add-by-name
;; hywconfig-delete-by-name
@@ -68,7 +68,7 @@
;;; Handling of name associations with each stored window configuration.
;;;###autoload
(defun hywconfig-add-by-name (name)
- "Saves the current window configuration under the string NAME.
+ "Save the current window configuration under the string NAME.
When called interactively and a window configuration already exists under
NAME, confirms whether or not to replace it."
(interactive "sName for current window configuration: ")
@@ -79,7 +79,7 @@ NAME, confirms whether or not to replace it."
(if (or (not (called-interactively-p 'interactive))
(not (set:member name wconfig-names))
(y-or-n-p
- (format "Replace existing `%s' window configuration: " name)))
+ (format "Replace existing `%s' window configuration? " name)))
(progn (hywconfig-set-names (set:replace name
(current-window-configuration)
wconfig-names))
(if (called-interactively-p 'interactive)
@@ -103,7 +103,7 @@ NAME, confirms whether or not to replace it."
;;;###autoload
(defun hywconfig-restore-by-name (name)
- "Restores frame-specific window configuration saved under NAME."
+ "Restore frame-specific window configuration saved under NAME."
(interactive (list (hargs:read-match "Restore window configuration named: "
(hywconfig-get-names) nil t)))
(cond ((null name)
@@ -120,12 +120,12 @@ NAME, confirms whether or not to replace it."
;;; Window configuration ring management (like text kill ring).
;;;###autoload
(defun hywconfig-delete-pop ()
- "Replaces the current frame's window configuration with the one most
recently saved to the ring.
+ "Replace the current frame's window configuration with the one most recently
saved to the ring.
Then deletes this new configuration from the ring."
(interactive)
(let ((ring (hywconfig-get-ring)))
(if (ring-empty-p ring)
- (error "(hywconfig-delete-pop): Window configuration save ring is
empty.")
+ (error "(hywconfig-delete-pop): Window configuration save ring is
empty")
(if (ring-empty-p ring)
(message "Window configuration save ring is now empty.")
(hywconfig-set-window-configuration (ring-ref ring 0))
@@ -133,12 +133,12 @@ Then deletes this new configuration from the ring."
;;;###autoload
(defun hywconfig-ring-empty-p ()
- "Returns t if the wconfig ring for the current frame is empty; nil
otherwise."
+ "Return t if the wconfig ring for the current frame is empty; nil otherwise."
(ring-empty-p (hywconfig-get-ring)))
;;;###autoload
(defun hywconfig-ring-save ()
- "Saves the current frame's window configuration onto the save ring.
+ "Save the current frame's window configuration onto the save ring.
Use {\\[hywconfig-yank-pop]} to restore it at a later time."
(interactive)
(ring-insert (hywconfig-get-ring) (current-window-configuration))
@@ -149,7 +149,7 @@ Use {\\[hywconfig-yank-pop]} to restore it at a later time."
;;;###autoload
(defun hywconfig-yank-pop (n)
- "Replaces the current frame's window configuration with the prefix arg Nth
prior one in save ring.
+ "Replace the current frame's window configuration with the prefix arg Nth
prior one in save ring.
Interactively, default value of N = 1, means the last saved window
configuration is displayed.
@@ -159,7 +159,7 @@ oldest one comes the newest one."
(let ((ring (hywconfig-get-ring))
prev)
(if (ring-empty-p ring)
- (error "(hywconfig-yank-pop): Window configuration save ring is empty.")
+ (error "(hywconfig-yank-pop): Window configuration save ring is empty")
(setq prev (ring-remove ring (- 1 n)))
(ring-insert-at-beginning ring prev)
(hywconfig-set-window-configuration (ring-ref ring 0)))))
@@ -169,7 +169,7 @@ oldest one comes the newest one."
;;; ************************************************************************
(defun hywconfig-get-names ()
- "Returns the current frame's list of named window configurations."
+ "Return the current frame's list of named window configurations."
(let* ((frame (selected-frame))
(names (frame-parameter frame 'hywconfig-names)))
(if (not names)
@@ -177,11 +177,11 @@ oldest one comes the newest one."
names))
(defun hywconfig-set-names (names)
- "Sets the current frame's list of named window configurations."
+ "Set the current frame's list of named window configurations."
(set-frame-parameter (selected-frame) 'hywconfig-names names))
(defun hywconfig-get-ring ()
- "Returns the current frame's window configuration ring."
+ "Return the current frame's window configuration ring."
(let* ((frame (selected-frame))
(ring (frame-parameter frame 'hywconfig-ring)))
(if (not ring)
diff --git a/kotl/kcell.el b/kotl/kcell.el
index 323af2c..e6a06df 100644
--- a/kotl/kcell.el
+++ b/kotl/kcell.el
@@ -46,7 +46,7 @@ Add to this list but don't remove any of the default
elements.")
(knode:copy kcell))
(defun kcell:create (contents idstamp &optional plist)
- "Return a new kcell which stores CONTENTS (a string or nil), has permanent
IDSTAMP (an integer), and optional additional property list, PLIST.
+ "Return a new kcell which store CONTENTS (a string or nil), has permanent
IDSTAMP (an integer), and optional additional property list, PLIST.
User id of `creator' of cell and `create-time' are added to cell's PLIST if
not already there."
(and contents (not (stringp contents))
@@ -81,7 +81,7 @@ not already there."
(knode:get-attr kcell 'plist))
(defun kcell:ref-to-id (cell-ref)
- "Returns a CELL-REF string converted to a cell identifier string.
+ "Return a CELL-REF string converted to a cell identifier string.
If CELL-REF contains both a relative and a permanent id, the permanent id is
returned. If CELL-REF is invalid, nil is returned.
diff --git a/kotl/kexport.el b/kotl/kexport.el
index cea41c6..dd3c8c2 100644
--- a/kotl/kexport.el
+++ b/kotl/kexport.el
@@ -115,7 +115,7 @@ pattern may be:
;;;###autoload
(defun kexport:html (export-from output-to &optional soft-newlines-flag)
"Export a koutline buffer or file in EXPORT-FROM to html format in OUTPUT-TO.
-By default, this retains newlines within cells as they are. With optional
prefix arg, SOFT-NEWLINES-FLAG,
+By default, this retains newlines within cells as they are. With optional
prefix arg, SOFT-NEWLINES-FLAG,
hard newlines are not used. Also converts Urls and Klinks into Html
hyperlinks.
STILL TODO:
Make delimited pathnames into file links (but not if within klinks).
diff --git a/kotl/kfile.el b/kotl/kfile.el
index a196ee3..89be15b 100644
--- a/kotl/kfile.el
+++ b/kotl/kfile.el
@@ -32,8 +32,8 @@
;;; Private variables
;;; ************************************************************************
-(defvar kfile:escape-newlines t
- "Value of print-escape-newlines used by `kfile:print-to-string' function.")
+(defvar kfile:escape-newlines t
+ "Value of `print-escape-newlines' used by `kfile:print-to-string' function.")
;;; ************************************************************************
;;; Entry Points
@@ -51,7 +51,7 @@ Return the new kview."
(and existing-file
(not (file-readable-p file-name))
(error
- "(kfile:find): \"%s\" is not readable. Check permissions."
+ "(kfile:find): \"%s\" is not readable. Check permissions"
file-name))
(setq buffer (find-file file-name))
;; Finding the file may have already done a kfile:read as invoked through
@@ -86,9 +86,9 @@ Return the new kview."
(let ((existing-file (file-exists-p file-name)))
(if existing-file
(if (not (file-readable-p file-name))
- (error "(kfile:view): \"%s\" is not readable. Check permissions."
+ (error "(kfile:view): \"%s\" is not readable. Check permissions"
file-name))
- (error "(kfile:view): \"%s\" does not exist." file-name))
+ (error "(kfile:view): \"%s\" does not exist" file-name))
(view-file file-name))
(kfile:narrow-to-kcells)
(goto-char (point-min)))
@@ -143,7 +143,7 @@ Return file's kview."
(goto-char (point-min))
(goto-char (kcell-view:start)))
;; Import buffer. Next line is necessary or the importation will fail.
- (delete-region (point-min) (point-max))
+ (delete-region (point-min) (point-max))
;; Import foreign buffer as koutline cells.
(kimport:file import-from (current-buffer))
;; If import buffer name starts with a space, kill it, as it is no
@@ -160,13 +160,13 @@ was previously read by calling `kfile:is-p'.
Return the new view."
(cond ((not (bufferp buffer))
- (error "(kfile:read): Argument must be a buffer, `%s'." buffer))
+ (error "(kfile:read): Argument must be a buffer, `%s'" buffer))
((and (zerop (buffer-size)) (not existing-file-p))
(kfile:create buffer))
((progn
(set-buffer buffer)
(not (or (stringp ver-string) (setq ver-string (kfile:is-p)))))
- (error "(kfile:read): `%s' is not a koutline file." buffer))
+ (error "(kfile:read): `%s' is not a koutline file" buffer))
((equal ver-string "Kotl-4.0")
(kfile:read-v4-or-v3 buffer nil))
((equal ver-string "Kotl-3.0")
@@ -175,7 +175,7 @@ Return the new view."
(kfile:read-v2 buffer))
((equal ver-string "Kotl-1.0")
(error "(kfile:read): V1 koutlines are no longer supported"))
- (t (error "(kfile:read): `%s' has unknown kotl version, %s."
+ (t (error "(kfile:read): `%s' has unknown kotl version, %s"
buffer ver-string))))
(defun kfile:read-v2 (buffer)
@@ -264,9 +264,9 @@ VISIBLE-ONLY-P is non-nil. Signal an error if kotl is not
attached to a file."
;; a file, so ensure it is nil.
(debug-on-error))
(cond ((null file)
- (error "(kfile:update): Current outline is not attached to a file."))
+ (error "(kfile:update): Current outline is not attached to a file"))
((not (file-writable-p file))
- (error "(kfile:update): File \"%s\" is not writable." file)))
+ (error "(kfile:update): File \"%s\" is not writable" file)))
(let* ((buffer-read-only)
(id-counter (kcell:get-attr top 'id-counter))
(kcell-data (make-vector (1+ id-counter) nil))
@@ -287,7 +287,7 @@ VISIBLE-ONLY-P is non-nil. Signal an error if kotl is not
attached to a file."
kview t)
;; Save top cell, 0, last since above loop may increment the total
;; number of cells counter stored in it, if any invalid cells are
- ;; encountered.
+ ;; encountered.
(aset kcell-data 0 (kcell-data:create top))
(setq id-counter (kcell:get-attr top 'id-counter))
;;
@@ -370,7 +370,7 @@ included in the list."
(lambda ()
(setq stack (cons sibling-p stack)
sibling-p nil)))
- (cons "\)"
+ (cons "\)"
(lambda ()
(setq sibling-p (car stack)
stack (cdr stack))))))))
@@ -385,7 +385,7 @@ included in the list."
(nreverse cell-list)))
(defun kfile:insert-attributes-v2 (kview kcell-list)
- "Set cell attributes within kview for each element in KCELL-LIST.
+ "Set cell attributes within KVIEW for each element in KCELL-LIST.
Assumes all cell contents are already in kview and that no cells are
hidden."
(let (buffer-read-only)
@@ -403,7 +403,7 @@ hidden."
(search-forward "\n\n" nil t)))))
(defun kfile:insert-attributes-v3 (kview kcell-vector)
- "Set cell attributes within kview for each element in KCELL-VECTOR.
+ "Set cell attributes within KVIEW for each element in KCELL-VECTOR.
Assumes all cell contents are already in kview and that no cells are
hidden."
(let ((kcell-num 1)
@@ -481,7 +481,7 @@ handle, whenever this is possible."
(if (looking-at "[ \t]*\)")
(delete-region (match-beginning 0) (match-end 0))
(error "Malformed quote"))
- (backward-sexp 1))
+ (backward-sexp 1))
((condition-case ()
(prog1 t (down-list 1))
(error nil))
diff --git a/kotl/kfill.el b/kotl/kfill.el
index a3e0c28..03ea0c8 100644
--- a/kotl/kfill.el
+++ b/kotl/kfill.el
@@ -51,13 +51,13 @@
((REGXP . FUNCTION) ...)
-When fill-paragraph is called, the REGEXP of each alist element is compared
+When `fill-paragraph' is called, the REGEXP of each alist element is compared
with the beginning of the current line. If a match is found the corresponding
FUNCTION is called. FUNCTION is called with one argument, which is non-nil
-when invoked on the behalf of fill-paragraph. It is the job of FUNCTION to
+when invoked on the behalf of `fill-paragraph'. It is the job of FUNCTION to
set the values of the paragraph-* variables (or set a clipping region, if
paragraph-start and paragraph-separate cannot be made discerning enough) so
-that fill-paragraph works correctly in various contexts.")
+that `fill-paragraph' works correctly in various contexts.")
;;; ************************************************************************
;;; Private variables
@@ -77,7 +77,7 @@ Setting this variable automatically makes it local to the
current buffer.")
(make-variable-buffer-local 'prior-fill-prefix)
;;; ************************************************************************
-;;; Public functions
+;;; Public functions
;;; ************************************************************************
(defun kfill:forward-line (&optional n)
@@ -196,7 +196,7 @@ fill prefix at the beginning of each line."
(re-search-backward (concat "\\`\\|" paragraph-separate))
(kfill:forward-line 1)
(let* ((region-start (point))
- (filladapt-mode
+ (filladapt-mode
(if prior-fill-prefix
;; filladapt-mode must be disabled for this command or it
;; will override the removal of prior-fill-prefix.
diff --git a/kotl/kimport.el b/kotl/kimport.el
index cd2a456..a5326a1 100644
--- a/kotl/kimport.el
+++ b/kotl/kimport.el
@@ -39,12 +39,12 @@ and a buffer/file into which to insert the imported
elements and a third
optional argument, CHILDREN-P, which when non-nil means insert imported cells
as the initial set of children of the current cell, if any.
- outline-mode - imported as an Emacs outline whose entries begin with
- asterisks;
+ `outline-mode' - imported as an Emacs outline whose entries begin with
+ asterisks;
.kot
- .kotl - imported as a structured koutline
+ .kotl - imported as a structured koutline
- all others - imported as text.")
+ all others - imported as text.")
;;;###autoload
(defvar kimport:suffix-alist
@@ -147,7 +147,7 @@ Set mark after the inserted text."
REGISTER is a character naming the register to insert.
Normally puts point before and mark after the inserted text.
If optional second arg is non-nil, puts mark before and point after.
-Interactively, second arg is non-nil if prefix arg is supplied."
+Interactively, second arg is non-nil if prefix ARG is supplied."
(interactive "*cInsert register: \nP")
(push-mark)
(let ((val (get-register register)))
@@ -245,7 +245,7 @@ an explanation of where imported cells are placed.
\"* \" = level 1, \"** \" = level 2 in outline and so on."
(interactive "FImport from star delimited cells buffer/file: \nFBuffer/file
to insert cells into: \nP")
(let ((output-level 1) (klabel "1")
- initially-empty-output no-renumber orig-point count total)
+ initially-empty-output no-renumber orig-point count total)
;; Don't change the order of import-from and output-to inits here.
(setq import-from (kimport:copy-and-set-buffer import-from)
output-to (kimport:initialize output-to)
@@ -422,7 +422,7 @@ The variable, `paragraph-start,' is used to determine
paragraphs."
(defun kimport:aug-post-statements (import-from output-to klabel output-level
import-level count total)
- "Insert post-numbered Augment statements (contents only) from IMPORT-FROM
into existing OUTPUT-TO.
+ "Insert post-numbered Augment statements (contents only) from IMPORT-FROM
into existing OUTPUT-TO.
KLABEL is the label to use for the first imported statement.
OUTPUT-LEVEL is the level at which to insert the first statement.
@@ -518,7 +518,7 @@ copied since there is no need to copy it to import it."
Return OUTPUT-TO buffer and set current buffer for the current command
to OUTPUT-TO.
-OUTPUT-TO may be a buffer, buffer-name or file name. If OUTPUT-TO exists
+OUTPUT-TO may be a buffer, `buffer-name' or file name. If OUTPUT-TO exists
already, it must be a koutline or an error will be signaled. For an existing
OUTPUT-TO, the text cells are inserted after the cell at point or after the
first cell for a newly loaded koutline. If OUTPUT-TO is nil, the current
@@ -567,7 +567,7 @@ will be added as children of the cell where this function
leaves point
(defun kimport:kcells (import-from output-to klabel output-level
import-level count total)
- "Insert visible koutline cells (contents and attributes) from IMPORT-FROM
into existing OUTPUT-TO.
+ "Insert visible koutline cells (contents and attributes) from IMPORT-FROM
into existing OUTPUT-TO.
KLABEL is the label to use for the first imported cell.
OUTPUT-LEVEL is the level at which to insert the first cell.
@@ -605,7 +605,7 @@ in IMPORT-FROM, used to show a running tally of the
imported cells."
(defun kimport:star-entries (import-from output-to klabel output-level
import-level count total)
- "Insert visible star outline entries from IMPORT-FROM into existing
OUTPUT-TO.
+ "Insert visible star outline entries from IMPORT-FROM into existing
OUTPUT-TO.
KLABEL is the label to use for the first imported entry.
OUTPUT-LEVEL is the level at which to insert the first entry.
diff --git a/kotl/klabel.el b/kotl/klabel.el
index 0328563..96f9d41 100644
--- a/kotl/klabel.el
+++ b/kotl/klabel.el
@@ -331,7 +331,7 @@ With optional CHILD-P, return label for first child cell of
PREV-LABEL cell."
"Set the labels of current cell, its following siblings and their subtrees.
CURRENT-CELL-LABEL is the label to display for the current cell.
LABEL-SEP-LEN is the length of the separation between a cell's label
-and the start of its contents."
+and the start of its contents."
(let (label-prefix label-suffix suffix-val suffix-function opoint)
(if current-cell-label
(setq label-suffix (klabel:to-kotl-label current-cell-label)
@@ -381,7 +381,7 @@ CURRENT-CELL-LABEL is the label to display for the current
cell."
"Set the labels of current cell, its following siblings and their subtrees.
CURRENT-CELL-LABEL is the label to display for the current cell.
LABEL-SEP-LEN is the length of the separation between a cell's label
-and the start of its contents."
+and the start of its contents."
(let (label-prefix label-suffix suffix-val opoint)
(if current-cell-label
(setq label-suffix (klabel:to-kotl-label current-cell-label)
@@ -463,7 +463,7 @@ and the start of its contents."
"Set the labels of current cell, its following siblings and their subtrees.
CURRENT-CELL-LABEL is the label to display for the current cell.
LABEL-SEP-LEN is the length of the separation between a cell's label
-and the start of its contents."
+and the start of its contents."
;; Only need to do this when switching from one label type to another,
;; i.e. when every cell label will be updated. So if not starting with the
;; first cell, do nothing.
@@ -489,7 +489,7 @@ If, however, it is \"0\", then all cell labels are updated."
(defun klabel-type:update-tree-labels (current-cell-label first-label)
"Update the labels of current cell and its subtree.
CURRENT-CELL-LABEL is the label to display for the current cell.
-Use `(klabel-type:update-labels "0")' to update all cells in an outline."
+Use `(klabel-type:update-labels \"0\")' to update all cells in an outline."
(let ((label-type (kview:label-type kview))
(label-sep-len (kview:label-separator-length kview)))
(save-excursion
@@ -506,8 +506,8 @@ Use `(klabel-type:update-labels "0")' to update all cells
in an outline."
;;; e.g. the full label "1a2" has kotl-label "2".
;;;
(defun kotl-label:alpha-to-int (alpha-label)
- "Return integer value of ALPHA-LABEL, e.g. `b' returns 2.
-Assumes ALPHA-LABEL is alphabetic and lowercase."
+ "Return integer value of ALPHA-LABEL, e.g. `b' return 2.
+Assume ALPHA-LABEL is alphabetic and lowercase."
(let ((power (length alpha-label))
(digit 0)
(min (1- ?a)))
@@ -543,7 +543,7 @@ LABEL must be >= 1 or >= a. If LABEL is decremented below
1 or a, an error
is signaled."
(if (not (kotl-label:is-p label))
(error
- "(kotl-label:increment): First arg, `%s', must be a kotl-label."
+ "(kotl-label:increment): First arg, `%s', must be a kotl-label"
label))
(let ((int-p) (val 0))
(if (or (setq int-p (kotl-label:integer-p label))
@@ -553,16 +553,16 @@ is signaled."
(progn (setq int-p (string-to-number label))
(if (> (setq val (+ int-p n)) 0)
(kotl-label:create val)
- (error "(kotl-label:increment): Decrement of `%s' by `%d'
is less than 1." label n)))
+ (error "(kotl-label:increment): Decrement of `%s' by `%d'
is less than 1" label n)))
;; alpha-p
(if (<= 0 (setq val (+ n (kotl-label:alpha-to-int label))))
(kotl-label:create (kotl-label:int-to-alpha val))
- (error "(kotl-label:increment): Decrement of `%s' by `%d' is
illegal." label n)))
+ (error "(kotl-label:increment): Decrement of `%s' by `%d' is
illegal" label n)))
(error "(kotl-label:increment): label, `%s', must be all digits or alpha
characters" label))))
(defun kotl-label:increment-alpha (label)
"Return alphabetic LABEL incremented by 1.
-For example, z would become aa, and aa would become bb. LABEL must be >= a."
+For example, z would become aa, and aa would become bb. LABEL must be >= a."
(kotl-label:int-to-alpha (1+ (kotl-label:alpha-to-int label))))
(defun kotl-label:increment-int (int-string)
diff --git a/kotl/klink.el b/kotl/klink.el
index d63d91f..6338828 100644
--- a/kotl/klink.el
+++ b/kotl/klink.el
@@ -116,7 +116,7 @@ link-end-position, (including delimiters)."
(if (and
;; Avoid false matches in certain modes.
(not (memq major-mode '(occur-mode moccur-mode amoccur-mode
- shell-mode telnet-mode ssh-mode term-mode)))
+ shell-mode telnet-mode ssh-mode term-mode)))
;; If this is an OO-Browser listing buffer, ignore anything that
;; looks like a klink, e.g. a C++ <template> class.
(if (fboundp 'br-browser-buffer-p)
@@ -225,7 +225,7 @@ See documentation for `kcell:ref-to-id' for valid cell-ref
formats."
(klink:update-label link start-pos obuf)))
(defun klink:parse (reference)
- "Returns (file-ref cell-ref) list parsed from REFERENCE string.
+ "Return (file-ref cell-ref) list parsed from REFERENCE string.
Either element of the list may be nil if REFERENCE does not contain that
element. REFERENCE should be one of the following forms (and may include an
optional pair of <> delimiters:
diff --git a/kotl/knode.el b/kotl/knode.el
index 43f31b2..ee06201 100644
--- a/kotl/knode.el
+++ b/kotl/knode.el
@@ -21,7 +21,7 @@
;;;
(defun knode:create (contents &optional prop-list)
- "Return a new knode which stores CONTENTS and optional PROP-LIST."
+ "Return a new knode which store CONTENTS and optional PROP-LIST."
(list 'knode
'contents contents
'plist prop-list))
@@ -30,7 +30,7 @@
"Return KNODE's contents."
(if (knode:is-p knode)
(car (cdr (memq 'contents knode)))
- (error "(knode:contents): Argument must be a knode.")))
+ (error "(knode:contents): Argument must be a knode")))
(defalias 'knode:copy 'copy-tree)
@@ -42,19 +42,19 @@
"Set KNODE's CONTENTS."
(if (knode:is-p knode)
(setcar (cdr (memq 'contents knode)) contents)
- (error "(knode:set-contents): First arg must be a knode.")))
+ (error "(knode:set-contents): First arg must be a knode")))
;;; ************************************************************************
;;; Private functions
;;; ************************************************************************
(defun knode:get-attr (obj attribute)
- "Return the value of OBJECT's ATTRIBUTE."
+ "Return the value of OBJ's ATTRIBUTE."
(car (cdr (memq attribute obj))))
(defun knode:remove-attr (obj attribute)
- "Remove OBJECT's ATTRIBUTE, if any, and return modified OBJECT.
-Use (setq object (knode:remove-attr object attribute)) to ensure that OBJECT
+ "Remove OBJ's ATTRIBUTE, if any, and return modified OBJ.
+Use (setq object (knode:remove-attr object attribute)) to ensure that OBJ
is updated."
(let ((tail obj)
sym
@@ -75,7 +75,7 @@ is updated."
obj))
(defun knode:set-attr (obj attribute value)
- "Set OBJECT's ATTRIBUTE to VALUE and return OBJECT."
+ "Set OBJ's ATTRIBUTE to VALUE and return OBJ."
(let ((attr (memq attribute obj)))
(if attr
(setcar (cdr attr) value)
diff --git a/kotl/kotl-mode.el b/kotl/kotl-mode.el
index 8ef1871..96f0cc6 100644
--- a/kotl/kotl-mode.el
+++ b/kotl/kotl-mode.el
@@ -605,7 +605,7 @@ but it will be copied to the kill ring and then an error
will be signaled."
(if read-only (barf-if-buffer-read-only))
)))
(error
- "(kotl-mode:kill-region): Bad region or not within a single Koutline
cell."))))
+ "(kotl-mode:kill-region): Bad region or not within a single Koutline
cell"))))
;; Bound to {C-w} when completion.el library is loaded.
(defalias 'kotl-mode:completion-kill-region 'kotl-mode:kill-region)
@@ -670,7 +670,7 @@ too long."
(defun kotl-mode:open-line (arg)
"Insert a newline and leave point before it.
-With arg N, insert N newlines."
+With ARG N, insert N newlines."
(interactive "*p")
(let* ((bolp (and (kotl-mode:bolp) (not (kotl-mode:bocp))))
(indent (kcell-view:indent))
@@ -727,7 +727,7 @@ useful for editing binary files."
(setq arg (1- arg)))))
(defun kotl-mode:set-fill-prefix (turn-off)
- "Sets fill prefix to line up to point.
+ "Set fill prefix to line up to point.
With prefix arg TURN-OFF or at begin of line, turns fill prefix off."
(interactive "P")
(set-fill-prefix (or turn-off (kotl-mode:bolp))))
@@ -868,7 +868,7 @@ See also the documentation strings for
`kotl-mode:delete-backward-char' and
"Kill up to and including prefix ARG'th occurrence of CHAR.
Goes backward if ARG is negative; error if CHAR not found."
(interactive "*p\ncZap to char within current cell: ")
- (kcell-view:operate
+ (kcell-view:operate
(lambda () (zap-to-char arg char))))
;;; ------------------------------------------------------------------------
@@ -1306,7 +1306,7 @@ Return number of cells left to move."
(defun kotl-mode:backward-paragraph (&optional arg)
"Move backward to start of paragraph.
-With arg N, do it N times; negative arg -N means move forward N paragraphs.
+With ARG N, do it N times; negative ARG -N means move forward N paragraphs.
Return point.
A paragraph start is the beginning of a line which is a
@@ -1552,7 +1552,7 @@ Return number of cells left to move."
(defun kotl-mode:forward-paragraph (&optional arg)
"Move point forward until after the last character of the current paragraph.
-With arg N, do it N times; negative arg -N means move backward N paragraphs.
+With ARG N, do it N times; negative ARG -N means move backward N paragraphs.
Return point.
A line which `paragraph-start' matches either separates paragraphs
@@ -1568,7 +1568,7 @@ part of the paragraph, or the end of the buffer."
(while (< arg 0)
(start-of-paragraph-text)
(setq arg (1+ arg))))
- (while (> arg 0)
+ (while (> arg 0)
(end-of-paragraph-text)
(setq arg (1- arg))))
(kotl-mode:to-valid-position)
@@ -1915,7 +1915,7 @@ If at tail cell already, do nothing and return nil."
(defun kotl-mode:eolp ()
"Return t if point is at the end of a visible line or the end of the buffer."
(or (eobp)
- (and (eolp)
+ (and (eolp)
(or (not (kview:char-invisible-p))
(not (kview:char-invisible-p (1- (point)))))
t)))
@@ -2027,7 +2027,7 @@ If assist-key is pressed:
(kotl-mode:add-cell -1))
(defun kotl-mode:add-cell (&optional relative-level contents plist no-fill)
- "Add a cell following current cell at optional RELATIVE-LEVEL with CONTENTS
string, attributes in PLIST, a property list, and NO-FILL flag to prevent any
filling of CONTENTS.
+ "Add a cell following current cell at optional RELATIVE-LEVEL with CONTENTS
string, attributes in PLIST, a property list, and NO-FILL flag to prevent any
filling of CONTENTS.
Optional prefix arg RELATIVE-LEVEL means add as sibling if nil or >= 0, as
child if equal to universal argument, {C-u}, and as sibling of current cell's
@@ -2060,7 +2060,7 @@ Return last newly added cell."
(progn
(goto-char start)
(error
- "(kotl-mode:add-cell): No higher level at which to add cell.")
+ "(kotl-mode:add-cell): No higher level at which to add cell")
)))
;; Skip from point past any children to next cell.
(if (kotl-mode:next-tree)
@@ -2272,7 +2272,7 @@ non-nil."
(let ((label-default (kcell-view:label)))
(hargs:iform-read
'(interactive
- (list
+ (list
(hargs:read "Mail tree: (0 for whole outline) "
nil label-default nil 'kcell)
(y-or-n-p "Include invisible text? "))))))
@@ -2413,7 +2413,7 @@ confirmation."
(defun kotl-mode:set-or-remove-cell-attribute (arg)
"With prefix ARG, interactively run kotl-mode:remove-cell-attribute;
otherwise, run kotl-mode:set-cell-attribute."
(interactive "P")
- (call-interactively
+ (call-interactively
(if arg #'kotl-mode:remove-cell-attribute #'kotl-mode:set-cell-attribute)))
(defun kotl-mode:split-cell (&optional arg)
@@ -2725,7 +2725,7 @@ Does not delete newline at end of line."
(defun kotl-mode:exchange-point-and-mark ()
"Put the mark where point is now, and point where the mark is now.
-This is like exchange-point-and-mark, but doesn't activate the mark."
+This is like `exchange-point-and-mark', but doesn't activate the mark."
(goto-char (prog1 (hypb:mark t)
(set-marker (hypb:mark-marker t) (point) (current-buffer)))))
@@ -2753,7 +2753,7 @@ on when tabs are used for indenting."
(if (kview:is-p kview)
t
(hypb:error
- "(kotl-mode:is-p): Command requires a valid Hyperbole koutline.")))
+ "(kotl-mode:is-p): Command requires a valid Hyperbole koutline")))
(defun kotl-mode:shrink-region ()
"If a region is active and outside the visible bounds of a single cell,
shrink it to within those bounds.
@@ -2846,7 +2846,7 @@ newlines at end of tree."
(move-to-column (if (numberp col) (round col) 0) nil)))
(defun kotl-mode:print-attributes (kview)
- "Print to the `standard-output' stream the attributes of the current visible
kcell.
+ "Print to the `standard-output' stream the attributes of the current visible
kcell.
Takes argument KVIEW (so it can be used with `kview:map-tree' and so that
KVIEW is bound correctly) but always operates upon the current view."
;; Move to start of visible cell to avoid printing attributes for an
@@ -3013,7 +3013,7 @@ Leave point at end of line now residing at START."
(progn
;; Make local-cmd have the same property list as cmd,
;; e.g. so pending-delete property is the same.
- (setplist local-cmd (symbol-plist cmd))
+ (setplist local-cmd (symbol-plist cmd))
(substitute-key-definition
cmd local-cmd kotl-mode-map global-map))))
diff --git a/kotl/kprop-xe.el b/kotl/kprop-xe.el
index 587d098..d92b608 100644
--- a/kotl/kprop-xe.el
+++ b/kotl/kprop-xe.el
@@ -74,7 +74,7 @@ properties."
;; of XEmacs.
(let ((extent (make-extent start end object)))
(if (null extent)
- (error "(kproperty:put): No extent at %d-%d to add properties %s"
+ (error "(kproperty:put): No extent at %d-%d to add properties %s"
start end property-list))
(if (/= (mod (length property-list) 2) 0)
(error "(kproperty:put): Property-list has odd number of elements, %s"
diff --git a/kotl/kview.el b/kotl/kview.el
index 47b0592..152d860 100644
--- a/kotl/kview.el
+++ b/kotl/kview.el
@@ -415,7 +415,7 @@ If between kcells, move to the previous one. The current
cell may be hidden."
(if pos (goto-char pos))
(kview:end-of-actual-line)
(cond ((null kview)
- (error "(kcell-view:to-label-end): Invalid kview; try {M-x kotl-mode
RET} to fix it."))
+ (error "(kcell-view:to-label-end): Invalid kview; try {M-x kotl-mode
RET} to fix it"))
(t
(let ((found))
(if (not (setq found (kproperty:get (1- (point)) 'kcell)))
@@ -518,7 +518,7 @@ level."
(forward-char 1)))
(defun kview:buffer (kview)
- "Return kview's buffer or nil if argument is not a kview."
+ "Return KVIEW's buffer or nil if argument is not a kview."
(if (kview:is-p kview)
(kview:get-attr kview 'view-buffer)))
@@ -557,11 +557,11 @@ BLANK-LINES, LEVELS-TO-SHOW, and LINES-TO-SHOW may also
be given, otherwise defa
(let ((buf (get-buffer buffer-name)))
(cond ((null buf)
- (error "(kview:create): No such buffer, `%s'." buffer-name))
+ (error "(kview:create): No such buffer, `%s'" buffer-name))
((or (null id-counter) (= id-counter 0))
(setq id-counter 0))
((not (integerp id-counter))
- (error "(kview:create): 2nd arg, `%s', must be an integer."
id-counter)))
+ (error "(kview:create): 2nd arg, `%s', must be an integer"
id-counter)))
(set-buffer buf)
;; Don't recreate view if it exists.
(unless (and (boundp 'kview) (kview:is-p kview) (eq (kview:buffer kview)
buf))
@@ -760,7 +760,7 @@ value may differ from the value passed in.)"
(if (listp object) (eq (car object) 'kview)))
(defun kview:kotl (kview)
- "Return kview's kotl object or nil if argument is not a kview."
+ "Return KVIEW's kotl object or nil if argument is not a kview."
(if (kview:is-p kview)
(kview:get-attr kview 'kotl)))
@@ -776,36 +776,36 @@ non-nil if cell is to be the child of the preceding cell."
(kview:get-attr kview 'label-function))
(defun kview:label-min-width (kview)
- "Return kview's label-min-width setting or nil if argument is not a kview.
+ "Return KVIEW's label-min-width setting or nil if argument is not a kview.
See documentation for kview:default-label-min-width."
(if (kview:is-p kview)
(kview:get-attr kview 'label-min-width)))
(defun kview:label-separator (kview)
- "Return kview's label-separator setting or nil if argument is not a kview.
+ "Return KVIEW's label-separator setting or nil if argument is not a kview.
See documentation for kview:default-label-separator."
(if (kview:is-p kview)
(kview:get-attr kview 'label-separator)))
(defun kview:label-separator-length (kview)
- "Return kview's label-separator length or nil if argument is not a kview.
+ "Return KVIEW's label-separator length or nil if argument is not a kview.
See documentation for kview:default-label-separator."
(kview:get-attr kview 'label-separator-length))
(defun kview:label-type (kview)
- "Return kview's label-type setting or nil if argument is not a kview.
+ "Return KVIEW's label-type setting or nil if argument is not a kview.
See documentation for kview:default-label-type."
(if (kview:is-p kview)
(kview:get-attr kview 'label-type)))
(defun kview:level-indent (kview)
- "Return kview's level-indent setting or nil if argument is not a kview.
+ "Return KVIEW's level-indent setting or nil if argument is not a kview.
See documentation for kview:default-level-indent."
(if (kview:is-p kview)
(kview:get-attr kview 'level-indent)))
(defun kview:map-branch (func kview &optional first-p visible-p)
- "Applies FUNC to the sibling trees from point forward within KVIEW and
returns results as a list.
+ "Apply FUNC to the sibling trees from point forward within KVIEW and return
results as a list.
With optional FIRST-P non-nil, begins with first sibling in current branch.
With optional VISIBLE-P, considers only those sibling cells that are visible
in the view.
@@ -835,7 +835,7 @@ See also `kview:map-region', `kview:map-siblings' and
`kview:map-tree'."
(nreverse results)))))
(defun kview:map-region (func kview &optional visible-p start end)
- "Applies FUNC to each cell in the region within KVIEW and returns results as
a list.
+ "Apply FUNC to each cell in the region within KVIEW and return results as a
list.
With optional VISIBLE-P, considers only those cells that are visible
in the view. With optional START and END positions, uses these rather
than the bounds of the active region.
@@ -875,7 +875,7 @@ See also `kview:map-tree', `kview:map-branch’, and
‘kview:map-siblings’."
(t (error "(kview:map-region): No region or invalid start and end
positions")))))))
(defun kview:map-siblings (func kview &optional first-p visible-p)
- "Applies FUNC to the sibling cells from point forward within KVIEW and
returns results as a list.
+ "Apply FUNC to the sibling cells from point forward within KVIEW and return
results as a list.
With optional FIRST-P non-nil, begins with first sibling in current branch.
With optional VISIBLE-P, considers only those sibling cells that are visible
in the view.
@@ -906,11 +906,11 @@ See also `kview:map-branch' and `kview:map-tree'."
(nreverse results)))))
(defun kview:map-expanded-tree (func kview &optional top-p)
- "Temporarily expands the tree at point, applies FUNC to the tree in the
KVIEW and returns results as a list.
+ "Temporarily expand the tree at point, apply FUNC to the tree in the KVIEW
and return results as a list.
This is for a FUNC that requires all cells in the tree be fully visible and
expanded before operating upon it. If this is not the case, use
`kview:map-tree' instead. FUNC may not change the number of or the order of
-the cells.
+the cells.
With optional TOP-P non-nil, maps over all of kview's cells.
@@ -961,7 +961,7 @@ See also `kview:map-region', `kview:map-branch' and
`kview:map-siblings'."
(nreverse results)))))
(defun kview:map-tree (func kview &optional top-p visible-p)
- "Applies FUNC to the tree starting at point within KVIEW and returns results
as a list.
+ "Apply FUNC to the tree starting at point within KVIEW and return results as
a list.
With optional TOP-P non-nil, maps over all of kview's cells.
With optional VISIBLE-P, considers only those cells that are visible in the
view.
@@ -1118,7 +1118,7 @@ displayed, since it has hidden branches."
kview t start end)))
(defun kview:set-label-type (kview new-type)
- "Change kview's label display type to NEW-TYPE, updating all displayed
labels.
+ "Change KVIEW's label display type to NEW-TYPE, updating all displayed
labels.
See documentation for variable, kview:default-label-type, for
valid values of NEW-TYPE."
(interactive (list kview
@@ -1139,7 +1139,7 @@ valid values of NEW-TYPE."
(intern new-type-str)))))
(if (not (memq new-type '(alpha legal id ;; no partial-alpha star
)))
- (error "(kview:set-label-type): Invalid label type, `%s'." new-type))
+ (error "(kview:set-label-type): Invalid label type, `%s'" new-type))
(let ((old-label-type (kview:label-type kview)))
(if (eq old-label-type new-type)
;; Per kview function definitions might have changed, so reset them.
@@ -1150,7 +1150,7 @@ valid values of NEW-TYPE."
(kvspec:update t))))
(defun kview:top-cell (kview)
- "Return kview's invisible top cell with idstamp 0 or nil if argument is not
a kview."
+ "Return KVIEW's invisible top cell with idstamp 0 or nil if argument is not
a kview."
(if (kview:is-p kview)
(kview:get-attr kview 'top-cell)))
@@ -1174,7 +1174,7 @@ or marker, `%s'" pos))
;;; ************************************************************************
(defun kview:get-attr (obj attribute)
- "Return the value of OBJECT's ATTRIBUTE."
+ "Return the value of OBJ's ATTRIBUTE."
(car (cdr (memq attribute (car (cdr (memq 'plist obj)))))))
(defun kcell-view:next-kcell (&optional visible-p label-sep-len)
@@ -1207,7 +1207,7 @@ unless no previous cell."
(progn (goto-char pos) t))))
(defun kview:set-attr (obj attribute value)
- "Set OBJECT's ATTRIBUTE to VALUE and return VALUE."
+ "Set OBJ's ATTRIBUTE to VALUE and return VALUE."
(let* ((plist-ptr (cdr (memq 'plist obj)))
(plist (car plist-ptr))
(attr (memq attribute plist)))
diff --git a/kotl/kvspec.el b/kotl/kvspec.el
index 9e0ee89..257c6e7 100644
--- a/kotl/kvspec.el
+++ b/kotl/kvspec.el
@@ -22,7 +22,7 @@
;; cNUM - set cutoff lines to NUM
;; descend: Only entries below this entry
;; + elide: Ellipses are on (now always true)
-;; e - ellipses on
+;; e - ellipses on
;; filter: Regexp or filter program to select entries for view,
;; off=select non-matching entries
;; glue: Freeze any group of entries selected to stay at top of
@@ -43,7 +43,7 @@
;; n~ - turn off labels
;; rest: Only following cells.
;; synthesize: Use a named generator function to generate entries for
-;; view.
+;; view.
;; view: Turn koutliner view mode on. Standard insertion keys then
;; can be used for browsing and view setting.
@@ -99,9 +99,9 @@ display all levels of cells."
nil nil t)))
(setq levels-to-keep (prefix-numeric-value levels-to-keep))
(if (< levels-to-keep 0)
- (error "(kvspec:levels-to-show): Must display at least one level."))
+ (error "(kvspec:levels-to-show): Must display at least one level"))
(kview:map-tree
- (lambda (kview)
+ (lambda (kview)
(if (/= (kcell-view:level) levels-to-keep)
(kotl-mode:show-tree)
(kotl-mode:hide-subtree)
@@ -139,7 +139,7 @@ VIEW-SPEC is a string or t, which means recompute the
current view
spec. A nil value of VIEW-SPEC updates the modeline viewspec display
to be current but does not recompute the viewspec itself. See
<${hyperb:dir}/kotl/EXAMPLE.kotl, 3b18=048> for details on valid
-view specs."
+view specs."
(cond ((stringp view-spec)
;; Use given view-spec after removing extraneous characters.
(setq view-spec
- [elpa] externals/hyperbole 519a7fc 14/21: Update pdf version of the manual, (continued)
- [elpa] externals/hyperbole 519a7fc 14/21: Update pdf version of the manual, Stefan Monnier, 2019/10/04
- [elpa] externals/hyperbole 6b44594 13/21: Add src and bin targets for test release setup, Stefan Monnier, 2019/10/04
- [elpa] externals/hyperbole 966628e 20/21: Merge new logo from branch 'master' of github.com:rswgnu/hyperbole, Stefan Monnier, 2019/10/04
- [elpa] externals/hyperbole 0ed7d26 10/21: Merge pull request #16 from matsl/set-up-hyperbole-for-use-from-src-folder, Stefan Monnier, 2019/10/04
- [elpa] externals/hyperbole 298fd12 15/21: Add optional key file path argument to e/ilinks, Stefan Monnier, 2019/10/04
- [elpa] externals/hyperbole a9620d1 16/21: 7.0.5 test release: add Action Buttons section to Hyperbole manual, Stefan Monnier, 2019/10/04
- [elpa] externals/hyperbole 8792e1c 19/21: Large changeset: add action ibtype, symtables to speed ibtype lookup, Stefan Monnier, 2019/10/04
- [elpa] externals/hyperbole 62a9db3 21/21: 7.0.6 test release: many changes, new logo; ibtypes speedups, Stefan Monnier, 2019/10/04
- [elpa] externals/hyperbole b4a2623 12/21: 7.0.4 test release: add Action Buttons and Implicit Button Names, Stefan Monnier, 2019/10/04
- [elpa] externals/hyperbole 985399e 17/21: New hyperbole banner, Stefan Monnier, 2019/10/04
- [elpa] externals/hyperbole 8f1f770 04/21: Apply some easy to fix flycheck suggestions,
Stefan Monnier <=
- [elpa] externals/hyperbole 713aca8 08/21: Merge pull request #13 from matsl/easy-to-fix-flycheck-issues, Stefan Monnier, 2019/10/04