Touch up the previous commit

Author: bbatsov

CHANGELOG.md

@@ -4,8 +4,8 @@
 
 ### New Features
 
-- Introduce `cider-start-nrepl-server` which does the same as `cider-jack-in` but without trying to connect to the started 
-nREPL server.
+- [#3555](https://github.com/clojure-emacs/cider/pull/3555): Introduce `cider-start-nrepl-server` which does the same as `cider-jack-in`
+but without trying to connect to the started nREPL server.
 
 ### Changes
 
@@ -17,7 +17,7 @@ nREPL server.
     - Improves keyword completion for ClojureScript.
 - [#3553](https://github.com/clojure-emacs/cider/issues/3553): `cider-pprint-eval-last-sexp`, `cider-eval-last-sexp-to-repl`, `cider-pprint-eval-last-sexp-to-repl`: use error overlays to indicate failure.
   - this also avoids showing an empty `*cider-result*` buffer.
-- [#3554](https://github.com/clojure-emacs/cider/issues/3554): CIDER macroexpand: handle errors more gracefully. 
+- [#3554](https://github.com/clojure-emacs/cider/issues/3554): CIDER macroexpand: handle errors more gracefully.
 
 ### Bugs fixed
 

cider.el

@@ -1305,8 +1305,8 @@ nil."
     (define-key map (kbd "j n") #'cider-start-nrepl-server)
     (define-key map (kbd "C-j j") #'cider-jack-in-clj)
     (define-key map (kbd "C-j s") #'cider-jack-in-cljs)
-    (define-key map (kbd "C-j n") #'cider-start-nrepl-server)
     (define-key map (kbd "C-j m") #'cider-jack-in-clj&cljs)
+    (define-key map (kbd "C-j n") #'cider-start-nrepl-server)
     (define-key map (kbd "C-j C-j") #'cider-jack-in-clj)
     (define-key map (kbd "C-j C-s") #'cider-jack-in-cljs)
     (define-key map (kbd "C-j C-m") #'cider-jack-in-clj&cljs)
@@ -1330,20 +1330,20 @@ nil."
   "CIDER jack-in and connect keymap.")
 
 (defun cider--start-nrepl-server (params &optional on-port-callback)
-  "Starts an nrepl server and passes the callback to it.
+  "Start an nREPL server.
 PARAMS is a plist optionally containing :project-dir and :jack-in-cmd.
-ON-PORT-CALLBACK is a function of one argument (server buffer)
+ON-PORT-CALLBACK (optional) is a function of one argument (server buffer)
 which is called by the process filter once the port of the connection has
-been determined.  Can be nil."
+been determined."
   (nrepl-start-server-process
    (plist-get params :project-dir)
    (plist-get params :jack-in-cmd)
    on-port-callback))
 
-
 (defun cider--update-params (params)
-  "Completes the passed in PARAMS from user input.
-Updates :project-dir, confirmation for existing session and :jack-in-cmd."
+  "Fill-in the passed in PARAMS plist needed to start an nREPL server.
+Updates :project-dir and :jack-in-cmd.
+Also checks whether a matching session already exists."
   (thread-first
     params
     (cider--update-project-dir)
@@ -1363,11 +1363,10 @@ double prefix prompt for all these parameters."
      (lambda (server-buffer)
        (cider-connect-sibling-clj params server-buffer)))))
 
-
 (defun cider-start-nrepl-server (params)
   "Start an nREPL server for the current project, but don't connect to it.
 PARAMS is a plist optionally containing :project-dir and :jack-in-cmd.
-With the prefix argument, allow editing of the start server in command; with a
+With the prefix argument, allow editing of the start server command; with a
 double prefix prompt for all these parameters."
   (interactive "P")
   (cider--start-nrepl-server (cider--update-params params)))

doc/modules/ROOT/pages/basics/up_and_running.adoc

@@ -276,10 +276,9 @@ would therefore fail.
 This assumes that the user will execute a `cider-connect` command manually afterwards,
 specifying host/port.
 
-For this scenario, the `cider-start-nrepl-server` kbd:[j n]  command is offered, which optionally
+For this scenario, the `cider-start-nrepl-server` (kbd:[C-c C-x (C-)j (C-)n])  command is provided, which
 takes the same parameters as `cider-jack-in`.
 
-
 == Connect to a Running nREPL Server
 
 If you have an nREPL server already running, CIDER can connect to
@@ -372,7 +371,7 @@ By 'containers' we mean Docker containers, or similar technologies, for running
 The files which we edit may / may not be edited using TRAMP. They could as well be mounted inside the container, so they appear as local.
 
 Because CIDER can't always detect if it's dealing with remote files, it's advisable to not rely on `cider-jack-in`
-and its remote support described above, but to 
+and its remote support described above, but to
 start the nREPL server via command line from inside the container, and `cider-connect` to it.
 
 This requires to first get a shell inside the running container and then start a nREPL server manually,
@@ -384,7 +383,7 @@ There are several solutions for this depending on the concrete scenario.
 
 === Working with Containers running on localhost
 
-The nREPL port should be set to a fixed value as we need to give this during the `docker start` command in order to forward the port from 
+The nREPL port should be set to a fixed value as we need to give this during the `docker start` command in order to forward the port from
 container to host. This requires as well that nREPL server listens to "0.0.0.0" and not only to "localhost".
 
 === Working with Containers running on remote hosts
@@ -401,7 +400,7 @@ https://containers.dev[Development Containers] is a standard to describe contain
 It uses Docker/Podman behind the scenes. So the principles of making sure that the nREPL port becomes available stay the same,
 but there are slightly different ways to configure this (given by the devcontainer standard).
 
-There are several CLI tools to manage devcontainers, as there are several container technologies. The following example uses 
+There are several CLI tools to manage devcontainers, as there are several container technologies. The following example uses
 link:https://github.com/devcontainers/cli[the devcontainers cli], but there are others (devpod, gitpod...).
 
 ==== Example: Working with containers (using `devcontainer`) on a remote server