From 5d8a721c48e5d839ed69c3cac7f2cf65c6998627 Mon Sep 17 00:00:00 2001 From: Jonas Bernoulli Date: Fri, 2 Oct 2020 15:08:00 +0200 Subject: Improve doc-strings of some options The whole first sentence should fit on the first line. If that makes the line a bit long then that is unfortunate but better than wrapping it onto a new line. When wrapping onto a new line anyway then the second line should never be intended. When it can be avoided, then long first lines should be made shorter. --- elisp/geiser-debug.el | 6 +++--- elisp/geiser-image.el | 6 +++--- elisp/geiser-impl.el | 4 ++-- elisp/geiser-repl.el | 6 ++---- 4 files changed, 10 insertions(+), 12 deletions(-) diff --git a/elisp/geiser-debug.el b/elisp/geiser-debug.el index ca51748..561aac2 100644 --- a/elisp/geiser-debug.el +++ b/elisp/geiser-debug.el @@ -32,7 +32,7 @@ "Whether to always display the sexp whose evaluation caused an error after the error message in the debug pop-up. If nil, expressions shorter than `geiser-debug-long-sexp-lines` lines are -show before the error message." +shown before the error message." :group 'geiser-debug :type 'boolean) @@ -46,7 +46,7 @@ has no effect." (geiser-custom--defcustom geiser-debug-jump-to-debug-p t "When set to t (the default), jump to the debug pop-up buffer - in case of evaluation errors. +in case of evaluation errors. See also `geiser-debug-show-debug-p`. " :group 'geiser-debug @@ -54,7 +54,7 @@ See also `geiser-debug-show-debug-p`. " (geiser-custom--defcustom geiser-debug-show-debug-p t "When set to t (the default), show the debug pop-up buffer in - case of evaluation errors. +case of evaluation errors. This option takes effect even if `geiser-debug-jump-to-debug-p` is set." diff --git a/elisp/geiser-image.el b/elisp/geiser-image.el index 2b496c2..ea253af 100644 --- a/elisp/geiser-image.el +++ b/elisp/geiser-image.el @@ -38,7 +38,7 @@ (geiser-custom--defcustom geiser-image-cache-dir nil "Default directory where generated images are stored. -If nil,the system wide tmp dir will be used." +If nil, then the system wide tmp dir will be used." :type 'path :group 'geiser-image) @@ -46,8 +46,8 @@ If nil,the system wide tmp dir will be used." 'button geiser-image "image buttons in terminal buffers") (geiser-impl--define-caller geiser-image--cache-dir image-cache-dir () - "Directory where generated images are stored. If this function -returns nil, no images are generated.") + "Directory where generated images are stored. +If this function returns nil, then no images are generated.") diff --git a/elisp/geiser-impl.el b/elisp/geiser-impl.el index 55d750e..246f84a 100644 --- a/elisp/geiser-impl.el +++ b/elisp/geiser-impl.el @@ -38,8 +38,8 @@ (geiser-custom--defcustom geiser-implementations-alist nil "A map from regular expressions or directories to implementations. When opening a new file, its full path will be matched against -each one of the regular expressions or directories in this map in order to -determine its scheme flavour." +each one of the regular expressions or directories in this map +in order to determine its scheme flavour." :type '(repeat (list (choice (group :tag "Regular expression" (const regexp) regexp) (group :tag "Directory" diff --git a/elisp/geiser-repl.el b/elisp/geiser-repl.el index 3907455..a18025c 100644 --- a/elisp/geiser-repl.el +++ b/elisp/geiser-repl.el @@ -63,8 +63,7 @@ switching to the Geiser REPL buffer." :group 'geiser-repl) (geiser-custom--defcustom geiser-repl-window-allow-split t - "Whether to allow window splitting when switching to the Geiser -REPL buffer." + "Whether to allow window splitting when switching to the Geiser REPL buffer." :type 'boolean :group 'geiser-repl) @@ -157,8 +156,7 @@ expression, if any." When set, Geiser won't check the version of the Scheme interpreter when starting a REPL, saving a few tenths of a -second. -" +second." :type 'boolean :group 'geiser-repl) -- cgit v1.2.3