Skip to content

Commit 0743744

Browse files
committed
More README improvements
1 parent c103f2a commit 0743744

File tree

1 file changed

+13
-10
lines changed

1 file changed

+13
-10
lines changed

README.md

Lines changed: 13 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,6 @@
22
[![MELPA][melpa-badge]][melpa-package]
33
[![MELPA Stable][melpa-stable-badge]][melpa-stable-package]
44
[![NonGNU ELPA](https://elpa.nongnu.org/nongnu/inf-clojure.svg)](https://elpa.nongnu.org/nongnu/inf-clojure.html)
5-
[![Discord](https://img.shields.io/badge/chat-on%20discord-7289da.svg?sanitize=true)](https://discord.com/invite/nFPpynQPME)
65
[![License GPL 3][badge-license]][copying]
76

87
# inf-clojure
@@ -301,7 +300,8 @@ information on how connect:
301300
((nil (inf-clojure-custom-startup "localhost" . 5555)))
302301
```
303302

304-
The socket server REPL configuration options are described [here](https://clojure.org/reference/repl_and_main#_launching_a_socket_server).
303+
The socket server REPL configuration options are described
304+
[here](https://clojure.org/reference/repl_and_main#_launching_a_socket_server).
305305

306306
#### Multiple Process Support
307307

@@ -314,9 +314,9 @@ buffers with `switch-to-buffer`.
314314

315315
> [!NOTE]
316316
>
317-
> If you're starting `inf-clojure` within a Clojure project directory
318-
> the name of the project will be incorporated into the name of the REPL buffer
319-
> - e.g. `*inf-clojure my-project*`.
317+
> If you're starting `inf-clojure` within a Clojure project directory the name
318+
> of the project will be incorporated into the name of the REPL buffer -
319+
> e.g. `*inf-clojure my-project*`.
320320
321321
Commands that send text from source buffers to Clojure processes (like `inf-clojure-eval-defun`
322322
or `inf-clojure-show-arglists`) have to choose a process to send to, when you have more than
@@ -355,10 +355,12 @@ acceptable buffers to set as the REPL buffer. If called with a prefix,
355355
it will always give the list even if you are currently in an
356356
acceptable REPL buffer.
357357

358-
**Tip:** Renaming buffers will greatly improve the
359-
functionality of this list; the list "project-1: clojure repl",
360-
"project-2: cljs repl" is far more understandable than "inf-clojure",
361-
"inf-clojure<2>".
358+
> [!TIP]
359+
>
360+
> Renaming buffers will greatly improve the
361+
> functionality of this list; the list "project-1: clojure repl",
362+
> "project-2: cljs repl" is far more understandable than "inf-clojure",
363+
> "inf-clojure<2>".
362364
363365
#### REPL Type
364366

@@ -444,9 +446,10 @@ but you can also use `inf-clojure-completions-fn` for specifying a
444446
function that given the REPL response should return Elisp data
445447
compatible with
446448
[`completion-at-point-functions`](https://www.gnu.org/software/emacs/manual/html_node/elisp/Completion-in-Buffers.html).
449+
447450
For more info run `M-x describe-variable RET
448451
inf-clojure-completions-fn`. Another option is to have a look at [how
449-
cider does
452+
CIDER does
450453
it](https://github.com/clojure-emacs/cider/blob/3e9ed12e8cfbad04d7618e649322765dc9bff5d6/cider-interaction.el#L595).
451454

452455
## Troubleshooting

0 commit comments

Comments
 (0)