branch: elpa/cider
commit fd84fad37dcc97ada838bbd5ac6617c949345242
Author: Kato Muso <m...@katomuso.io>
Commit: Kato Muso <m...@katomuso.io>

    Tweak docstring of cider-docstring--format
---
 cider-docstring.el | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/cider-docstring.el b/cider-docstring.el
index be45f2ded4..007bb0a8b7 100644
--- a/cider-docstring.el
+++ b/cider-docstring.el
@@ -148,7 +148,7 @@ Prioritize rendering as much as possible while staying 
within `cider-docstring-m
     (concat string (when (> (length lines) max-lines) "..."))))
 
 (defun cider-docstring--format (string)
-  "Performs formatting of STRING, cleaning up some common whitespace issues."
+  "Return a nicely formatted STRING to be displayed to the user."
   (let* ((string (replace-regexp-in-string "\\.  " ".\n\n" string)) ;; improve 
the formatting of e.g. clojure.core/reduce
          (string (mapconcat (lambda (line)
                               ;; Remove spaces at the beginning of each line, 
as it is common in many clojure.core defns:

Reply via email to