Shorten over-long docstrings to fit within 80 columns

End users compiling CIDER from MELPA see "docstring wider than 80
characters" warnings because the byte compiler defaults to a 80-col
limit (the project's Eldev sets it to 100 internally, which masked
these locally).  Reword or wrap the offending lines so they're
clean for end users too.

Author: bbatsov

lisp/cider-docstring.el

@@ -79,21 +79,22 @@ otherwise, it's included as-is."
                              ""))))
 
 (defcustom cider-docstring-max-lines 20
-  "The maximum number of docstring lines that will be rendered in a UI widget (or the echo area).
+  "Maximum number of docstring lines rendered in a UI widget or the echo area.
 
 Note that `cider-docstring' will trim thing smartly, for Java doc comments:
 * First, the whole doc comment will be attempted to be rendered.
 * If that exceeds `cider-docstring-max-lines',
   we will use only the first sentence and the block tags
   (that is, the params/throws/returns info).
 * If that exceeds `cider-docstring-max-lines', we will use only the block tags.
-* If that exceeds `cider-docstring-max-lines', we will use only the first sentence."
+* If that exceeds `cider-docstring-max-lines', we will use only the first
+  sentence."
   :type 'integer
   :group 'cider
   :package-version '(cider . "1.8.0"))
 
 (defun cider--attempt-invalid? (attempt)
-  "Check if ATTEMPT is either nil or exceeds `cider-docstring-max-lines' in line count."
+  "Check if ATTEMPT is nil or has more lines than `cider-docstring-max-lines'."
   (or (not attempt)
       (and attempt
            (> (length (split-string attempt "\n"))
@@ -106,7 +107,8 @@ Note that `cider-docstring' will trim thing smartly, for Java doc comments:
 
 (defun cider--render-docstring (eldoc-info)
   "Renders the docstring from ELDOC-INFO based on its length and content.
-Prioritize rendering as much as possible while staying within `cider-docstring-max-lines'."
+Prioritize rendering as much as possible while staying within
+`cider-docstring-max-lines'."
   (let* ((first-sentence-fragments (cider-plist-get eldoc-info "doc-first-sentence-fragments"))
          (body-fragments (cider-plist-get eldoc-info "doc-fragments"))
          (block-tags-fragments (cider-plist-get eldoc-info "doc-block-tags-fragments"))

lisp/cider-eval.el

@@ -484,7 +484,8 @@ Show error overlay in BUFFER if needed."
   "A few example values that will match:
 \"Reflection warning, /tmp/foo/src/foo/core.clj:14:1 - \"
 \"Syntax error compiling at (src/workspace_service.clj:227:3).\"
-\"Unexpected error (ClassCastException) macroexpanding defmulti at (src/haystack/parser.cljc:21:1).\"")
+\"Unexpected error (ClassCastException) macroexpanding defmulti at
+ (src/haystack/parser.cljc:21:1).\"")
 
 
 (defconst cider-module-info-regexp

lisp/cider-find.el

@@ -255,8 +255,8 @@ integer on successful finds, nil otherwise."
   "Find the namespace of the keyword at point and its primary occurrence there.
 
 For instance - if the keyword at point is \":cider.demo/keyword\", this command
-would find the namespace \"cider.demo\" and afterwards find the primary (most relevant or first)
-mention of \"::keyword\" there.
+would find the namespace \"cider.demo\" and afterwards find the primary
+\(most relevant or first) mention of \"::keyword\" there.
 
 Prompt according to prefix ARG and `cider-prompt-for-symbol'.
 A single or double prefix argument inverts the meaning of

lisp/cider-inspector.el

@@ -261,7 +261,7 @@ current buffer's namespace."
       (cider-inspector--render-value result :next-inspectable))))
 
 (defun cider-inspect-expr-from-inspector ()
-  "Performs `cider-inspect-expr' in a way that is suitable from the Inspector itself.
+  "Run `cider-inspect-expr' in a way that's suitable from the Inspector itself.
 In particular, it does not read `cider-sexp-at-point'."
   (interactive)
   (let* ((ns (cider-current-ns))

lisp/cider-macroexpansion.el

@@ -42,7 +42,7 @@ Possible values are:
 
   `qualified' ;=> Vars are fully-qualified in the expansion
   `none'      ;=> Vars are displayed without namespace qualification
-  `tidy'      ;=> Vars that are :refer-ed or defined in the current namespace are
+  `tidy'      ;=> Vars that are :refer-ed or in the current namespace are
                  displayed with their simple name, non-referred vars from other
                  namespaces are referred using the alias for that namespace (if
                  defined), other vars are displayed fully qualified."

lisp/cider-mode.el

@@ -648,9 +648,10 @@ that should be font-locked:
    `var': Any non-local var gets the `font-lock-variable-name-face'.
    `deprecated' (default): Any deprecated var gets the `cider-deprecated-face'
    face.
-   `core' (default): Any symbol from clojure.core/cljs.core.  The selected face will depend on type.
-   Note that while rendering `core', all types of vars (`macro', `function', `var', `deprecated')
-   will be honored, regardless of the user's customization value.
+   `core' (default): Any symbol from clojure.core/cljs.core.  The selected
+   face will depend on type.  Note that while rendering `core', all types of
+   vars (`macro', `function', `var', `deprecated') will be honored,
+   regardless of the user's customization value.
 
 The value can also be t, which means to font-lock as much as possible."
   :type '(choice (set :tag "Fine-tune font-locking"

lisp/cider-repl.el

@@ -1773,7 +1773,7 @@ constructs."
 
 The checking is done as follows:
 
-* If the current buffer's name equals to the value of `cider-test-report-buffer',
+* If the current buffer's name equals the value of `cider-test-report-buffer',
   only accept the given session's repl if it equals `cider-test--current-repl'
 * Consider if the buffer belongs to `cider-ancillary-buffers'
 * Consider the buffer's filename, strip any Docker/TRAMP details from it

lisp/cider.el

@@ -1422,8 +1422,8 @@ These are used as arguments to the commands `cider-connect-clj',
 the corresponding user prompts.
 
 This defcustom is intended for use with .dir-locals.el on a per-project basis.
-See `cider-connect-default-cljs-params' in order to specify a separate set of params
-for cljs REPL connections.
+See `cider-connect-default-cljs-params' in order to specify a separate set
+of params for cljs REPL connections.
 
 Note: it is recommended to set the variable `cider-default-cljs-repl'
 instead of specifying the :cljs-repl-type key."