Skip to content

Commit

Permalink
Soften the warning around cider-nrepl version mismatches
Browse files Browse the repository at this point in the history
Especially given we try to inflict as few breaking changes as possible (#2960),
a version mismatch might simply mean that one is using a more recent cider-nrepl version (without one having bothered to customize the related `defcustom` to silence this).

This commit proposes a softer wording for the warning, so that people feel less alarmed in face of these.

Else one gives the quite untruthful impression that things are more fragile/coupled than they actually are.
  • Loading branch information
vemv committed Oct 5, 2021
1 parent 2b8bde3 commit 4971ae6
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 2 deletions.
2 changes: 1 addition & 1 deletion cider-connection.el
Expand Up @@ -245,7 +245,7 @@ message in the REPL area."
"CIDER requires cider-nrepl to be fully functional. Some features will not be available without it!"))
((not (cider--compatible-middleware-version-p cider-required-middleware-version middleware-version))
(cider-emit-manual-warning "troubleshooting.html#cider-complains-of-the-cider-nrepl-version"
"CIDER %s requires cider-nrepl %s, but you're currently using cider-nrepl %s. The version mismatch might break some functionality!"
"cider.el %s assumes cider-nrepl %s, but you're currently using cider-nrepl %s. That might be fine, however it is recommended that you ensure the versions are consistent, especially before reporting any issue."
cider-version cider-required-middleware-version middleware-version)))))

(declare-function cider-interactive-eval-handler "cider-eval")
Expand Down
2 changes: 1 addition & 1 deletion doc/modules/ROOT/pages/troubleshooting.adoc
Expand Up @@ -207,7 +207,7 @@ effect of changes you have to restart Emacs.
This is a warning displayed on the REPL buffer when it starts, and usually looks like this:

____
*WARNING:* CIDER 0.18.0 requires cider-nrepl x.y.z, but you're currently using cider-nrepl a.b.c. Some functionality may not work properly!
*WARNING:* cider.el 1.1.1 assumes cider-nrepl x.y.z, but you're currently using cider-nrepl a.b.c. That might be fine, however it is recommended that you ensure the versions are consistent, especially before reporting any issue.
____

where `a.b.c` might be an actual version, like `0.17.0`, or it might be `not installed` or `nil`.
Expand Down

0 comments on commit 4971ae6

Please sign in to comment.