Remove leading asterix from defcustom docstrings (#837)

Author: matsl

ChangeLog

@@ -1,3 +1,7 @@
+2025-12-31  Mats Lidell  <matsl@gnu.org>
+
+* Remove starting asterix from defcustom variable docstrings.
+
 2025-12-25  Mats Lidell  <matsl@gnu.org>
 
 * hywiki.el (hywiki--preparation-function, hywiki--completion-function)

hmail.el

@@ -3,7 +3,7 @@
 ;; Author:       Bob Weiner
 ;;
 ;; Orig-Date:     9-Oct-91 at 18:38:05
-;; Last-Mod:      5-Jan-25 at 12:01:15 by Bob Weiner
+;; Last-Mod:     31-Dec-25 at 16:02:19 by Mats Lidell
 ;;
 ;; SPDX-License-Identifier: GPL-3.0-or-later
 ;;
@@ -56,7 +56,7 @@
  "Major mode for reading USENET news with Hyperbole buttons.")
 
 (defcustom hmail:init-function nil
-  "*Function (a symbol) to initialize Hyperbole support for a mail reader/composer.
+  "Function (a symbol) to initialize Hyperbole support for a mail reader/composer.
 Valid values are: nil, Mh-init or Rmail-init."
   :type '(choice (const nil)
 		 (const Mh-init)

hmouse-tag.el

@@ -3,7 +3,7 @@
 ;; Author:       Bob Weiner
 ;;
 ;; Orig-Date:    24-Aug-91
-;; Last-Mod:      7-Dec-25 at 20:25:10 by Bob Weiner
+;; Last-Mod:     31-Dec-25 at 16:02:19 by Mats Lidell
 ;;
 ;; SPDX-License-Identifier: GPL-3.0-or-later
 ;;
@@ -111,7 +111,7 @@ should insert the implicit link type definition name.")
 (define-obsolete-variable-alias 'smart-asm-include-dirs
   'smart-asm-include-path "06.00")
 (defcustom smart-asm-include-path nil
-  "*Ordered list of directories to search for assembly language include files.
+  "Ordered list of directories to search for assembly language include files.
 Each directory must end with a directory separator."
   :type '(repeat directory)
   :group 'hyperbole-commands)
@@ -130,7 +130,7 @@ Examples include:
 (define-obsolete-variable-alias 'smart-c-cpp-include-dirs
   'smart-c-cpp-include-path "06.00")
 (defcustom smart-c-cpp-include-path '("/usr/include/")
-  "*Ordered list of include directories by default searched by C/C++ preprocessor.
+  "Ordered list of include directories by default searched by C/C++ preprocessor.
 Each directory must end with a directory separator.  See also
 `smart-c-include-path'."
   :type '(repeat directory)
@@ -139,7 +139,7 @@ Each directory must end with a directory separator.  See also
 (define-obsolete-variable-alias 'smart-c-include-dirs
   'smart-c-include-path "06.00")
 (defcustom smart-c-include-path nil
-  "*Ordered list of directories to search for C/C++ include files.
+  "Ordered list of directories to search for C/C++ include files.
 Each directory must end with a directory separator.  Directories normally
 searched by the C/C++ pre-processor should be set instead in
 `smart-c-cpp-include-path'."
@@ -173,7 +173,7 @@ File name is grouping 3.")
 (defcustom smart-java-package-path
   (and (fboundp 'getenv) (getenv "JAVA_HOME")
        (list (expand-file-name "src/" (file-name-as-directory (getenv "JAVA_HOME")))))
-  "*Ordered list of directories to search for imported Java packages.
+  "Ordered list of directories to search for imported Java packages.
 Each directory must end with a directory separator."
   :type '(repeat directory)
   :group 'hyperbole-commands)
@@ -186,12 +186,12 @@ Each directory must end with a directory separator."
 Keyword matched is grouping 1.  Referent is grouping 2.")
 
 (defcustom smart-emacs-tags-file nil
-  "*Full path name of etags file for GNU Emacs source."
+  "Full path name of etags file for GNU Emacs source."
   :type '(file :must-match t)
   :group 'hyperbole-commands)
 
 (defcustom smart-tags-mode-list '(fundamental-mode prog-mode text-mode)
-  "*Major modes where programming symbols are recognized by the Smart Keys."
+  "Major modes where programming symbols are recognized by the Smart Keys."
   :type '(repeat symbol)
   :group 'hyperbole-commands)
 

hpath.el

@@ -3,7 +3,7 @@
 ;; Author:       Bob Weiner
 ;;
 ;; Orig-Date:     1-Nov-91 at 00:44:23
-;; Last-Mod:      7-Dec-25 at 21:12:14 by Bob Weiner
+;; Last-Mod:     31-Dec-25 at 16:08:46 by Mats Lidell
 ;;
 ;; SPDX-License-Identifier: GPL-3.0-or-later
 ;;
@@ -43,7 +43,7 @@
 					      icomplete-mode ivy-mode
 					      org-roam-mode vertico-mode
                                               selectrum-mode)
-  "*List of boolean mode variables whose modes automatically list completions.
+  "List of boolean mode variables whose modes automatically list completions.
 These are modes where completions are listed without the need for
 pressing the ? key."
   :type '(repeat variable)
@@ -355,7 +355,7 @@ Call this function manually if mount points change after Hyperbole is loaded."
 ;;; ************************************************************************
 
 (defcustom hpath:external-open-office-suffixes "doc[mx]?\\|od[st]\\|ppsx?\\|ppt[mx]?\\|v[dst][s]?[tx]\\|vsd[x]?\\|xls[mx]?"
-  "*Regexp of Open Office document suffix alternatives.
+  "Regexp of Open Office document suffix alternatives.
 These are to be display externally with the Action Key
 Do not include an initial period or enclosing grouping parentheses;
 these will be added automatically.
@@ -366,7 +366,7 @@ possible suffixes."
   :group 'hyperbole-commands)
 
 (defcustom hpath:external-file-suffixes "e?ps\\|dvi\\|pdf\\|ps\\.g?[zZ]\\|gif\\|tiff?\\|xpm\\|xbm\\|xwd\\|pm\\|pbm\\|jpe?g\\|xcf"
-  "*Non-operating system dependent regexp of file suffixes to open outside Emacs.
+  "Non-operating system dependent regexp of file suffixes to open outside Emacs.
 These are opened with the Action Key when not handled by
 `hpath:native-image-suffixes'.  Do not include an initial period
 or enclosing grouping parentheses; these will be added
@@ -378,7 +378,7 @@ automatically."
 								  hpath:external-open-office-suffixes
 								  hpath:external-file-suffixes)
 							  "open"))
-  "*An alist of (FILENAME-REGEXP . DISPLAY-PROGRAM-STRING-OR-LIST) for the macOS.
+  "An alist of (FILENAME-REGEXP . DISPLAY-PROGRAM-STRING-OR-LIST) for the macOS.
 See the function `hpath:get-external-display-alist' for detailed
 format documentation."
   :type '(alist :key-type regexp :value-type string)
@@ -388,7 +388,7 @@ format documentation."
 							      "openoffice.exe")
 							(cons (format "\\.\\(%s\\|vba\\)$" hpath:external-file-suffixes)
 							      "/c/Windows/System32/cmd.exe //c start \"${@//&/^&}\""))
-  "*An alist of (FILENAME-REGEXP . DISPLAY-PROGRAM-STRING-OR-LIST) for MS Windows.
+  "An alist of (FILENAME-REGEXP . DISPLAY-PROGRAM-STRING-OR-LIST) for MS Windows.
 See the function `hpath:get-external-display-alist' for detailed
 format documentation."
   :type '(alist :key-type regexp :value-type string)
@@ -408,7 +408,7 @@ format documentation."
 							      hpath:external-open-office-suffixes
 							      hpath:external-file-suffixes)
 						      "setsid -w xdg-open"))
-  "*An alist of (FILENAME-REGEXP . DISPLAY-PROGRAM-STRING-OR-LIST) for X.
+  "An alist of (FILENAME-REGEXP . DISPLAY-PROGRAM-STRING-OR-LIST) for X.
 See the function `hpath:get-external-display-alist' for detailed
 format documentation."
   :type '(alist :key-type regexp :value-type string)
@@ -456,7 +456,7 @@ format documentation."
 		  (error "Invalid file"))))))
 
     '("\\.rdb\\'" . rdb:initialize)))
-  "*Alist for calling special functions to display file types in Emacs.
+  "Alist for calling special functions to display file types in Emacs.
 The alist consists of (FILENAME-REGEXP . EDIT-FUNCTION) elements.
 See also the function (hpath:get-external-display-alist) for
 external display program settings."
@@ -558,7 +558,7 @@ Used only if the function `image-mode' is defined."
 ;;
 (defcustom hpath:variables
   '(hyperb:dir hywiki-directory load-path exec-path Info-directory-list sm-directory)
-  "*List of Emacs Lisp variable symbols to substitute within matching link paths.
+  "List of Emacs Lisp variable symbols to substitute within matching link paths.
 Each variable value, if bound, must be either a pathname or a list of pathnames.
 When embedded within a path, the format is ${variable}."
   :type '(repeat variable)
@@ -572,7 +572,7 @@ When embedded within a path, the format is ${variable}."
   "*Url pattern for (hpath:rfc rfc-num) to get the RFC document for `rfc-num'.")
 
 (defcustom hpath:suffixes '(".gz" ".Z")
-  "*List of filename suffixes to add or remove within hpath calls.
+  "List of filename suffixes to add or remove within hpath calls.
 Used by `hpath:exists-p' and `hpath:substitute-dir'."
   :type '(repeat string)
   :group 'hyperbole-commands)

hproperty.el

@@ -3,7 +3,7 @@
 ;; Author:       Bob Weiner
 ;;
 ;; Orig-Date:    21-Aug-92
-;; Last-Mod:      5-Oct-25 at 16:41:34 by Mats Lidell
+;; Last-Mod:     31-Dec-25 at 16:02:19 by Mats Lidell
 ;;
 ;; SPDX-License-Identifier: GPL-3.0-or-later
 ;;
@@ -41,24 +41,24 @@
 ;;; ************************************************************************
 
 (defcustom hproperty:but-highlight-flag t
-  "*Non-nil means highlight named Hyperbole buttons with `hproperty:but-face'."
+  "Non-nil means highlight named Hyperbole buttons with `hproperty:but-face'."
   :type 'boolean
   :group 'hyperbole-buttons)
 
 (defcustom hproperty:but-emphasize-flag nil
-  "*Non-nil means emphasize selectability of Hyperbole button labels.
+  "Non-nil means emphasize selectability of Hyperbole button labels.
 This is shown when hovering over the button with the mouse."
   :type 'boolean
   :group 'hyperbole-buttons)
 
 (defcustom hproperty:but-flash-time 1000
-  "*Emacs button flash delay."
+  "Emacs button flash delay."
   :type '(integer :match (lambda (_widget value) (and (integerp value) (> value 0))))
   :group 'hyperbole-buttons)
 (make-obsolete-variable 'hproperty:but-flash-time "Use `hproperty:but-flash-time-seconds' instead" "8.0")
 
 (defcustom hproperty:but-flash-time-seconds 0.05
-  "*Emacs button flash delay."
+  "Emacs button flash delay."
   :type 'float
   :group 'hyperbole-buttons)
 

hsettings.el

@@ -3,7 +3,7 @@
 ;; Author:       Bob Weiner
 ;;
 ;; Orig-Date:    15-Apr-91 at 00:48:49
-;; Last-Mod:     29-Jun-24 at 18:57:18 by Bob Weiner
+;; Last-Mod:     31-Dec-25 at 16:06:23 by Mats Lidell
 ;;
 ;; SPDX-License-Identifier: GPL-3.0-or-later
 ;;
@@ -101,12 +101,12 @@ The Smart Menu system must have already been loaded.  If a Smart
 Menu is already displayed, perform another Action or Assist Key function.")
 
 (defcustom hmouse-middle-flag (and (boundp 'infodock-version) infodock-version t)
-  "*Non-nil means additionally bind the middle mouse button as an Action Key."
+  "Non-nil means additionally bind the middle mouse button as an Action Key."
   :type 'boolean
   :group 'hyperbole-keys)
 
 (defcustom smart-scroll-proportional t
-  "*Non-nil means Smart Key scroll behavior is relative to current line.
+  "Non-nil means Smart Key scroll behavior is relative to current line.
 Smart Keys will scroll relative to current line when pressed at
 the end of a line.  Action Key moves current line to top of the
 window.  Assist Key moves current line to bottom of the window.
@@ -233,7 +233,7 @@ disable/inhibit support."
 	       (if inhibit-hyperbole-messaging "disabled" "enabled"))))
 
 (defcustom inhibit-hyperbole-messaging t
-  "*Determine 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,
@@ -251,7 +251,7 @@ Hyperbole, and then restart Emacs."
   :group 'hyperbole-buttons)
 
 (defcustom hyperbole-web-search-browser-function browse-url-browser-function
-  "*Function of one url argument called by any Hyperbole Find/Web search."
+  "Function of one url argument called by any Hyperbole Find/Web search."
   :type 'function
   :group 'hyperbole-commands)
 
@@ -275,7 +275,7 @@ Hyperbole, and then restart Emacs."
     ("Wikipedia" . "https://en.wikipedia.org/wiki/%s")
     ("X" . "https://x.com/search?q=%s")
     ("Youtube" . "https://www.youtube.com/results?search_query=%s"))
-  "*Alist of (web-service-name . emacs-cmd-or-url-with-%s-parameter) elements.
+  "Alist of (web-service-name . emacs-cmd-or-url-with-%s-parameter) elements.
 The first capitalized character of each web-service-name must be unique.
 This custom option is used in the Hyperbole Find/Web menu where
 the %s in the url-with-%s-parameter is replaced with an interactively

hui-mini.el

@@ -3,7 +3,7 @@
 ;; Author:       Bob Weiner
 ;;
 ;; Orig-Date:    15-Oct-91 at 20:13:17
-;; Last-Mod:     30-Nov-25 at 17:51:11 by Bob Weiner
+;; Last-Mod:     31-Dec-25 at 16:08:46 by Mats Lidell
 ;;
 ;; SPDX-License-Identifier: GPL-3.0-or-later
 ;;
@@ -1039,7 +1039,7 @@ command instead.  Typically prevents clashes over {\\`C-c' /}."
 ;;; ************************************************************************
 
 (defcustom hui:menu-highlight-flag t
-  "*If non-nil, highlight the first capitalized character of each menu item.
+  "If non-nil, highlight the first capitalized character of each menu item.
 Highlight with `read-multiple-choice-face'.  The display must
 support underlined faces as well."
   :type 'boolean
@@ -1081,7 +1081,7 @@ support underlined faces as well."
 	 (when (fboundp 'consult-grep) ;; allow for autoloading
 	   '("WikiWordConsult" hywiki-word-consult-grep
 	     "Use `hywiki-consult-grep' to show occurrences of a prompted for HyWikiWord."))))
-  "*Hyperbole minibuffer HyWiki menu items of the form:
+  "Hyperbole minibuffer HyWiki menu items of the form:
 \(LABEL-STRING ACTION-SEXP DOC-STR)."
   :set  (lambda (var value)
 	  (if (fboundp #'hyperbole-minibuffer-menu)
@@ -1112,7 +1112,7 @@ support underlined faces as well."
 	 '("TagFind"          hyrolo-tags-view              "Find HyRolo Org tags.")
 	 '("WordFind"         hyrolo-word                   "Find entries containing words.")
 	 '("Yank"             hyrolo-yank                   "Find an entry containing a string and insert it at point.")))
-  "*Hyperbole minibuffer Rolo menu items of the form:
+  "Hyperbole minibuffer Rolo menu items of the form:
 \(LABEL-STRING ACTION-SEXP DOC-STR)."
   :set  (lambda (var value)
 	  (if (fboundp #'hyperbole-minibuffer-menu)

hui-mouse.el

@@ -3,7 +3,7 @@
 ;; Author:       Bob Weiner
 ;;
 ;; Orig-Date:    04-Feb-89
-;; Last-Mod:      7-Dec-25 at 20:15:46 by Bob Weiner
+;; Last-Mod:     31-Dec-25 at 16:02:19 by Mats Lidell
 ;;
 ;; SPDX-License-Identifier: GPL-3.0-or-later
 ;;
@@ -130,34 +130,34 @@ In any other context, signal an error."
     (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.
+  "Function run by the Action Key in an unspecified context.
 Set it to `hyperbole' if you want it to display the Hyperbole minibuffer menu."
   :type 'function
   :group 'hyperbole-keys)
 
 (defcustom assist-key-default-function #'assist-key-error
-  "*Function run by the Assist Key in an unspecified context.
+  "Function run by the Assist Key in an unspecified context.
 Set it to `hkey-summarize' if you want it to display a summary of
 Smart Key behavior."
   :type 'function
   :group 'hyperbole-keys)
 
 (defcustom action-key-modeline-buffer-id-function #'dired-jump
-  "*Function to call for Action Key clicks on the buf id portion of a modeline.
+  "Function to call for Action Key clicks on the buf id portion of a modeline.
 Its default value is `dired-jump'; set it to `smart-treemacs-modeline'
 to use the Treemacs file manager package instead."
   :type 'function
   :group 'hyperbole-keys)
 
 (defcustom action-key-eol-function #'smart-scroll-up
-  "*Function run by the Action Key at the end of a line.
+  "Function run by the Action Key at the end of a line.
 Its default value is `smart-scroll-up'.  To disable it, set it to
 #\\='ignore."
   :type 'function
   :group 'hyperbole-keys)
 
 (defcustom assist-key-eol-function #'smart-scroll-down
-  "*Function run by the Assist Key at the end of a line.
+  "Function run by the Assist Key at the end of a line.
 Its default value is `smart-scroll-down'.  To disable it, set it to
 #\\='ignore."
   :type 'function