Function: cider-repl--help-contents

cider-repl--help-contents is a byte-compiled function defined in cider-repl.el.

Signature

(cider-repl--help-contents)

Documentation

Return the text shown in the cider-repl-help buffer.

A compact reference for the REPL workflow: interacting at the prompt, loading code, switching namespaces and moving between the REPL and source.

Source Code

;; Defined in ~/.emacs.d/elpa/cider-20260822.1520/cider-repl.el
(defun cider-repl--help-contents ()
  "Return the text shown in the `cider-repl-help' buffer.
A compact reference for the REPL workflow: interacting at the prompt, loading
code, switching namespaces and moving between the REPL and source."
  (concat
   (propertize "CIDER REPL Reference\n\n" 'face 'cider-repl-help-heading)
   (cider-repl--help-section
    "At the prompt"
    '(("(doc name)"    . "documentation for a var")
      ("(find-doc re)" . "search documentation")
      ("(source name)" . "source of a var")
      ("(javadoc cls)" . "Javadoc for a class or object")
      ("*1  *2  *3"    . "the last three results")
      ("*e"            . "the last exception")))
   "\n"
   (cider-repl--help-section
    "In the REPL"
    '((cider-repl-handle-shortcut          . "run a REPL shortcut (,help lists them)")
      (cider-history                       . "browse input history")
      (cider-repl-previous-input           . "previous input")
      (cider-repl-next-input               . "next input")
      (cider-repl-clear-output             . "clear the last output")
      (cider-interrupt                     . "interrupt evaluation")
      (cider-repl-set-ns                   . "set the REPL ns to the current one")
      (cider-switch-to-last-clojure-buffer . "jump to the last Clojure buffer")
      (cider-quit                          . "quit the REPL")))
   "\n"
   (cider-repl--help-section
    "From a source buffer"
    '((cider-load-buffer                           . "load (eval) the buffer")
      (cider-load-file                             . "load (eval) a file")
      (cider-switch-to-repl-buffer                 . "jump to the REPL (C-u: also sync its ns)")
      (cider-load-buffer-and-switch-to-repl-buffer . "load the buffer, then jump to the REPL"))
    'cider-mode-map)
   "\n"
   "More:  "
   (cider-repl--help-button "REPL startup info" #'cider-repl-describe-startup
                            "Show how this REPL was started")
   "    "
   (cider-repl--help-button "User manual" #'cider-view-manual
                            "Open the CIDER user manual")
   "    "
   (cider-repl--help-button "Customize CIDER" (lambda () (customize-group 'cider))
                            "Customize the cider group")
   "    "
   (cider-repl--help-button "Report a bug" #'cider-report-bug
                            "Report a bug or a suggestion")
   "\n\n"
   "Press q to dismiss.\n"))