branch: elpa/cider
commit c330c459e3678e3ff62d8606c8ccdf55f30e4d3a
Author: Bozhidar Batsov <[email protected]>
Commit: Bozhidar Batsov <[email protected]>
[Docs] Fix a bunch of typos
---
doc/modules/ROOT/pages/about/support.adoc | 2 +-
doc/modules/ROOT/pages/about/team.adoc | 2 +-
doc/modules/ROOT/pages/additional_packages.adoc | 4 ++--
doc/modules/ROOT/pages/additional_resources.adoc | 2 +-
doc/modules/ROOT/pages/basics/up_and_running.adoc | 12 ++++++------
doc/modules/ROOT/pages/caveats.adoc | 4 ++--
doc/modules/ROOT/pages/cljs/configuration.adoc | 2 +-
doc/modules/ROOT/pages/cljs/figwheel.adoc | 6 +++---
doc/modules/ROOT/pages/cljs/overview.adoc | 4 ++--
doc/modules/ROOT/pages/cljs/shadow-cljs.adoc | 2 +-
doc/modules/ROOT/pages/config/basic_config.adoc | 4 ++--
doc/modules/ROOT/pages/config/project_config.adoc | 2 +-
doc/modules/ROOT/pages/contributing/docs.adoc | 4 ++--
doc/modules/ROOT/pages/contributing/hacking.adoc | 14 +++++++-------
doc/modules/ROOT/pages/debugging/debugger.adoc | 2 +-
doc/modules/ROOT/pages/debugging/inspector.adoc | 10 +++++-----
doc/modules/ROOT/pages/debugging/logging.adoc | 8 ++++----
doc/modules/ROOT/pages/debugging/profiling.adoc | 4 ++--
doc/modules/ROOT/pages/debugging/tracing.adoc | 2 +-
doc/modules/ROOT/pages/faq.adoc | 6 +++---
doc/modules/ROOT/pages/platforms/basilisp.adoc | 8 ++++----
doc/modules/ROOT/pages/platforms/nbb.adoc | 2 +-
doc/modules/ROOT/pages/platforms/other_platforms.adoc | 2 +-
doc/modules/ROOT/pages/platforms/overview.adoc | 4 ++--
doc/modules/ROOT/pages/repl/configuration.adoc | 4 ++--
doc/modules/ROOT/pages/repl/history.adoc | 2 +-
doc/modules/ROOT/pages/repl/keybindings.adoc | 2 +-
doc/modules/ROOT/pages/troubleshooting.adoc | 10 +++++-----
doc/modules/ROOT/pages/usage/cider_mode.adoc | 4 ++--
doc/modules/ROOT/pages/usage/code_completion.adoc | 4 ++--
doc/modules/ROOT/pages/usage/code_evaluation.adoc | 16 ++++++++--------
doc/modules/ROOT/pages/usage/dealing_with_errors.adoc | 2 +-
doc/modules/ROOT/pages/usage/managing_connections.adoc | 2 +-
doc/modules/ROOT/pages/usage/misc_features.adoc | 4 ++--
.../ROOT/pages/usage/working_with_documentation.adoc | 8 ++++----
35 files changed, 85 insertions(+), 85 deletions(-)
diff --git a/doc/modules/ROOT/pages/about/support.adoc
b/doc/modules/ROOT/pages/about/support.adoc
index e4096508d14..c1921ab3a65 100644
--- a/doc/modules/ROOT/pages/about/support.adoc
+++ b/doc/modules/ROOT/pages/about/support.adoc
@@ -26,7 +26,7 @@ users. If you need an invite you can go
http://clojurians.net/[here].
There's also another channel named `#emacs` for generic Emacs discussions.
-NOTE: Bozhidar Slack handle is `bozhidar`, instead of `bbatsov`.
+NOTE: Bozhidar's Slack handle is `bozhidar`, instead of `bbatsov`.
== StackOverflow
diff --git a/doc/modules/ROOT/pages/about/team.adoc
b/doc/modules/ROOT/pages/about/team.adoc
index d0b24ebbc42..d0accc3a4da 100644
--- a/doc/modules/ROOT/pages/about/team.adoc
+++ b/doc/modules/ROOT/pages/about/team.adoc
@@ -12,7 +12,7 @@ of the CIDER core team, listed in the order of joining it:
== CIDER Alumni
-In addition, we'd like to extend a special thanks the following retired CIDER
+In addition, we'd like to extend a special thanks to the following retired
CIDER
core team members. Lovingly known as The Alumni:
* https://github.com/kingtim[Tim King] (original author)
diff --git a/doc/modules/ROOT/pages/additional_packages.adoc
b/doc/modules/ROOT/pages/additional_packages.adoc
index a4dcc2297d1..bf86d674e8e 100644
--- a/doc/modules/ROOT/pages/additional_packages.adoc
+++ b/doc/modules/ROOT/pages/additional_packages.adoc
@@ -15,7 +15,7 @@ The packages listed here belong to three categories:
IMPORTANT: Make sure that the version of any extension you've installed is
compatible with
your CIDER version.
-CIDER extensions typically are Emacs packages that built on top of CIDER's
Emacs Lisp API.
+CIDER extensions typically are Emacs packages that are built on top of CIDER's
Emacs Lisp API.
Some of them ship with extra nREPL middleware as well (e.g. `clj-refactor`).
Typically
packages that rely on middleware would hook into CIDER's middleware injection
functionality and inject their own functionality automatically as well.
@@ -110,7 +110,7 @@ Clojure.
=== subword-mode
-Enabling `CamelCase` support for editing commands(like
+Enabling `CamelCase` support for editing commands (like
`forward-word`, `backward-word`, etc) in the REPL is quite useful since
we often have to deal with Java class and method names. The built-in
Emacs minor mode `subword-mode` provides such functionality:
diff --git a/doc/modules/ROOT/pages/additional_resources.adoc
b/doc/modules/ROOT/pages/additional_resources.adoc
index 9a5c7dcbd71..590acee26b7 100644
--- a/doc/modules/ROOT/pages/additional_resources.adoc
+++ b/doc/modules/ROOT/pages/additional_resources.adoc
@@ -44,6 +44,6 @@ dedicated to CIDER 0.12.
== Tutorials
-IMPORTANT: Keep in mind that third-party tutorials might be outdated by time
you get to read them.
+IMPORTANT: Keep in mind that third-party tutorials might be outdated by the
time you get to read them.
* https://practicalli.github.io/spacemacs/[Clojure Development with Spacemacs]
diff --git a/doc/modules/ROOT/pages/basics/up_and_running.adoc
b/doc/modules/ROOT/pages/basics/up_and_running.adoc
index e32ff1d5f0b..265338a1d54 100644
--- a/doc/modules/ROOT/pages/basics/up_and_running.adoc
+++ b/doc/modules/ROOT/pages/basics/up_and_running.adoc
@@ -213,7 +213,7 @@ with
=== Customizing the Jack-in Command Behavior
You can use kbd:[C-u M-x] `cider-jack-in` kbd:[RET] to specify the exact
command
-that `cider-jack-in` would run. This option is very useful is you want to e.g.
+that `cider-jack-in` would run. This option is very useful if you want to e.g.
specify extra Leiningen profiles or `deps.edn` aliases.
Alternatively you can kbd:[C-u C-u M-x] `cider-jack-in` kbd:[RET], which is a
@@ -227,7 +227,7 @@ NOTE: The examples use only `cider-jack-in`, but this
behavior is consistent
for all `cider-jack-in-\*` commands.
You can further customize the command line CIDER uses for `cider-jack-in` by
-modifying the some options. Those differ a bit between the various tools,
+modifying some options. Those differ a bit between the various tools,
so we'll examine them tool by tool.
==== Leiningen Options
@@ -391,9 +391,9 @@ of ssh for remote connection unconditionally.
WARNING: As nREPL connections are insecure by default, you're encouraged to
use only SSH
tunneling when connecting to servers running outside of your network.
-There's a another case in which CIDER may optionally leverage the `ssh`
command - when
+There's another case in which CIDER may optionally leverage the `ssh` command
- when
trying to figure out potential target hosts and ports when you're doing
`cider-connect-\*`.
-If `cider-infer-remote-nrepl-ports` is true, CIDER will use ssh to try to
infer
+If `cider-infer-remote-nrepl-ports` is true, CIDER will use ssh to try to infer
nREPL ports on remote hosts (for a direct connection). That option is also set
to `nil`
by default.
@@ -459,7 +459,7 @@ In this scenario and assuming a folder
`/home/me/my-clj-code` containing the rel
devcontainer up --workspace-folder /home/me/my-clj-code
----
-Then we can start a nREPL server inside the container on the remote host as
shown below (executed from from your local machine).
+Then we can start a nREPL server inside the container on the remote host as
shown below (executed from your local machine).
The command tunnels as well the remote port 12345 to local machine on port
12345:
[source,sh]
@@ -497,7 +497,7 @@ When locally running nREPL servers, there is the option to
listen on a
socket file instead of opening a network port. As long as access to
the parent directory of the socket is sufficiently protected, this is
much more secure than the network port, since any local user can
-access the port-provided REPL. It can also be be helpful in other
+access the port-provided REPL. It can also be helpful in other
cases, e.g. when working with virtual networks (containers) where
sharing a file socket can be vastly simpler than managing bridge
networks and firewall setups.
diff --git a/doc/modules/ROOT/pages/caveats.adoc
b/doc/modules/ROOT/pages/caveats.adoc
index 132ea33e6c2..a33dd66db22 100644
--- a/doc/modules/ROOT/pages/caveats.adoc
+++ b/doc/modules/ROOT/pages/caveats.adoc
@@ -60,7 +60,7 @@ from your Emacs config.
== ClojureCLR Support
-CIDER currently has very basic support ClojureCLR (via Arcadia's nREPL
server). The reasons for this are the following:
+CIDER currently has very basic support for ClojureCLR (via Arcadia's nREPL
server). The reasons for this are the following:
* nREPL itself runs only on the JVM (because it leverages Java APIs
internally). There's an
@@ -74,7 +74,7 @@ If someone would like to tackle them, we'd be happy to
provide assistance.
== Injecting dependencies and Leiningen pedantic: abort mode
Because injection currently creates an override of the nREPL dependency that
-Leingingen also pulls in starting up the REPL will fail if `:pedantic? :abort`
+Leiningen also pulls in starting up the REPL will fail if `:pedantic? :abort`
is set. There are several ways to address this:
* Remove the `:pedantic? :abort` setting.
diff --git a/doc/modules/ROOT/pages/cljs/configuration.adoc
b/doc/modules/ROOT/pages/cljs/configuration.adoc
index 86831104d85..e9af5f47f2c 100644
--- a/doc/modules/ROOT/pages/cljs/configuration.adoc
+++ b/doc/modules/ROOT/pages/cljs/configuration.adoc
@@ -84,7 +84,7 @@ ClojureScript REPL, you can invoke
== Enhanced Completion
By default CIDER will enrich the ClojureScript completion results using
-the https://github.com/rksm/clj-suitable[suitable] library. If case you run
+the https://github.com/rksm/clj-suitable[suitable] library. In case you run
into any `suitable`-related issues you can disable the enhanced completion
like this:
[source,lisp]
diff --git a/doc/modules/ROOT/pages/cljs/figwheel.adoc
b/doc/modules/ROOT/pages/cljs/figwheel.adoc
index d6aa5950c0e..06c34420548 100644
--- a/doc/modules/ROOT/pages/cljs/figwheel.adoc
+++ b/doc/modules/ROOT/pages/cljs/figwheel.adoc
@@ -1,8 +1,8 @@
= Using Figwheel
:experimental:
-Figwheel is one of the most popular ClojureScript REPLs today. Below you'll
-instructions how to setup and use it with CIDER.
+Figwheel is one of the most popular ClojureScript REPLs today. Below you'll
find
+instructions on how to set up and use it with CIDER.
NOTE: There are two versions of Figwheel out there - the legacy
https://github.com/bhauman/lein-figwheel[figwheel] and
the modern https://github.com/bhauman/figwheel-main[figwheel-main]. You're
@@ -127,7 +127,7 @@ in the root of your Leiningen project definition.
[figwheel-sidecar "0.5.19"] ; use here whatever the current version of
figwheel is
----
+
-WARNING: Keep in mind that CIDER does not support versions versions of
Piggieback older than 0.4. Make sure that you use a compatible version of
Figwheel.
+WARNING: Keep in mind that CIDER does not support versions of Piggieback older
than 0.4. Make sure that you use a compatible version of Figwheel.
+
. Add this to your dev `:repl-options` (not needed for `cider-jack-in-cljs`):
+
diff --git a/doc/modules/ROOT/pages/cljs/overview.adoc
b/doc/modules/ROOT/pages/cljs/overview.adoc
index 1ca5004a46d..a25295620fa 100644
--- a/doc/modules/ROOT/pages/cljs/overview.adoc
+++ b/doc/modules/ROOT/pages/cljs/overview.adoc
@@ -16,7 +16,7 @@ and how to setup the most popular ClojureScript REPLs.
== nREPL and ClojureScript
-nREPL doesn't natively support ClojureScript evaluation, that why an additional
+nREPL doesn't natively support ClojureScript evaluation, that's why an
additional
middleware is needed. For most REPLs (with the notable exceptions of
`shadow-cljs`, `nbb`), CIDER relies on the popular Piggieback middleware for its
ClojureScript support.
@@ -80,7 +80,7 @@ cljs.user>
----
This difference comes from a performance optimization in Piggieback, which
avoids
-creating an different REPLs for each ClojureScript form it evaluates.
+creating different REPLs for each ClojureScript form it evaluates.
TIP: You can learn more about this difference
https://github.com/nrepl/piggieback/pull/98[here].
diff --git a/doc/modules/ROOT/pages/cljs/shadow-cljs.adoc
b/doc/modules/ROOT/pages/cljs/shadow-cljs.adoc
index de7f07abf18..f5f5d38237e 100644
--- a/doc/modules/ROOT/pages/cljs/shadow-cljs.adoc
+++ b/doc/modules/ROOT/pages/cljs/shadow-cljs.adoc
@@ -1,7 +1,7 @@
= Using shadow-cljs
:experimental:
-`shadow-cljs` is one of the most popular toolchain for doing ClojureScript
+`shadow-cljs` is one of the most popular toolchains for doing ClojureScript
development these days. In this section we'll discuss how to set it up and
use it together with CIDER.
diff --git a/doc/modules/ROOT/pages/config/basic_config.adoc
b/doc/modules/ROOT/pages/config/basic_config.adoc
index 9320da28976..bfff3bdb9a6 100644
--- a/doc/modules/ROOT/pages/config/basic_config.adoc
+++ b/doc/modules/ROOT/pages/config/basic_config.adoc
@@ -144,7 +144,7 @@ established. This behavior is configurable via
`cider-connection-message-fn`:
(setq cider-connection-message-fn nil)
----
-The default message are stored in the variable `cider-words-of-inspiration`
that
+The default messages are stored in the variable `cider-words-of-inspiration`
that
you can tweak easily yourselves:
[source,lisp]
@@ -186,7 +186,7 @@ suppress them from appearing in some buffer switching
commands like
(setq nrepl-hide-special-buffers t)
----
-If you need to make the hidden buffers appear When using
+If you need to make the hidden buffers appear when using
`switch-to-buffer`, type kbd:[SPC] after issuing the command. The
hidden buffers will always be visible in `list-buffers` (kbd:[C-x C-b]).
diff --git a/doc/modules/ROOT/pages/config/project_config.adoc
b/doc/modules/ROOT/pages/config/project_config.adoc
index e3ca2356263..2f6db43806d 100644
--- a/doc/modules/ROOT/pages/config/project_config.adoc
+++ b/doc/modules/ROOT/pages/config/project_config.adoc
@@ -40,7 +40,7 @@ Emacs Lisp code. If you, however, feel
overwhelmed by its syntax you can simply do `M-x add-dir-local-variable` and
you'll be able to select the major-mode, the variable and its value
interactively. One small problem with this approach is that the resulting
-`.dir-local.el` will be created in the current directory, which may be a
problem
+`.dir-locals.el` will be created in the current directory, which may be a
problem
depending on what you're trying to do. Users of
https://github.com/bbatsov/projectile[Projectile] may leverage the
project-aware `projectile-edit-dir-locals` command instead.
diff --git a/doc/modules/ROOT/pages/contributing/docs.adoc
b/doc/modules/ROOT/pages/contributing/docs.adoc
index 123af5e1260..976bd6ca337 100644
--- a/doc/modules/ROOT/pages/contributing/docs.adoc
+++ b/doc/modules/ROOT/pages/contributing/docs.adoc
@@ -58,8 +58,8 @@ It can also be triggered manually if needed.
IMPORTANT: Don't forget to update the manual's version metadata when cutting
CIDER releases.
It lives in `doc/antora.yml`.
-When cutting new releases you'll have to updated `antora-playbook.yml` to
mention
-their relevant tags from which the documentation needs to be build. Here's how
this
+When cutting new releases you'll have to update `antora-playbook.yml` to
mention
+their relevant tags from which the documentation needs to be built. Here's how
this
looks for one of the projects:
[source]
diff --git a/doc/modules/ROOT/pages/contributing/hacking.adoc
b/doc/modules/ROOT/pages/contributing/hacking.adoc
index f8d11227add..926ca3f155e 100644
--- a/doc/modules/ROOT/pages/contributing/hacking.adoc
+++ b/doc/modules/ROOT/pages/contributing/hacking.adoc
@@ -8,7 +8,7 @@ working on the Emacs Lisp side (CIDER) and the Clojure side
(`cider-nrepl`).
=== Obtaining the source code
-People typically install CIDER via `package.el`. While this gives you access
the
+People typically install CIDER via `package.el`. While this gives you access
to the
source code (as it's part of the package), it's always a much better idea to
simply clone the code from GitHub and use it. In general - avoid editing the
code of an installed package.
@@ -63,14 +63,14 @@ evaluating the code you've altered/added with commands like
`C-M-x`,
`eval-buffer` and so on.
Once you've evaluated the new code, you can invoke some interactive command
that
-uses it internally or open a Emacs Lisp REPL and experiment with it there. You
+uses it internally or open an Emacs Lisp REPL and experiment with it there. You
can open an Emacs Lisp REPL with `M-x ielm`.
You can also quickly evaluate some Emacs Lisp code in the minibuffer with
`M-:`.
=== Testing the code
-The code you've wrote should ideally be covered by specs. We use
+The code you've written should ideally be covered by specs. We use
the https://github.com/jorgenschaefer/emacs-buttercup[buttercup] library for
CIDER's specs. If you're familiar with `Jasmine` or `RSpec` you'll feel right
at
home.
@@ -198,7 +198,7 @@ writing tests.
. Absolute paths. It is a common practice to use dummy absolute paths,
such as `/tmp/a-dir` or `/docker/src, in tests,` as test inputs. These
are not valid absolute paths on Windows though, since they are missing
-the initial driver letter (e.g.`c:/tmp/a-dir`), but we can wrap them
+the initial drive letter (e.g.`c:/tmp/a-dir`), but we can wrap them
around with `expand-file-name` to make them so e.g. in tests
+
[source,emacs-lisp]
@@ -211,7 +211,7 @@ around with `expand-file-name` to make them so e.g. in tests
. Command-line arguments. When calling external programs, it might be
necessary to quote some long command line arguments, though quoting
-rules are different on Windows (shells) that they are on Unix. Use
+rules are different on Windows (shells) than they are on Unix. Use
`shell-quote-argument` to achieve the desired compatibility across the
different architectures.
@@ -227,13 +227,13 @@ Just do `cider-jack-in` within the `cider-nrepl` project
and start hacking as
you would on any other Clojure project. The only thing to keep in mind is that
you'll have to restart CIDER when you add new middleware.
-The jacked-in project's definitions will take precedence over the once you have
+The jacked-in project's definitions will take precedence over the ones you have
from a binary `cider-nrepl` installation. This means it's pretty easy to get
immediate feedback for the changes you've made.
=== Testing the code
-The code you've wrote should ideally be covered by test. We use the
+The code you've written should ideally be covered by tests. We use the
`clojure.test` library for ``cider-nrepl``'s tests.
You can run the tests you authored/changed straight from Emacs. Consult the
diff --git a/doc/modules/ROOT/pages/debugging/debugger.adoc
b/doc/modules/ROOT/pages/debugging/debugger.adoc
index 3df79dcdd55..c4504a57205 100644
--- a/doc/modules/ROOT/pages/debugging/debugger.adoc
+++ b/doc/modules/ROOT/pages/debugging/debugger.adoc
@@ -270,7 +270,7 @@ wrapped in a `breakpoint`):
* In `(fn [x] (inc x))` the return value is a function object and carries no
information. Note that this is not the same as the return value when you
-*call* this function (which *is* interesting). Also, even those this form
+*call* this function (which *is* interesting). Also, even though this form
is not wrapped in a breakpoint, the forms inside it *are* (`(inc x)` and
`x`).
* Similarly, in a form like `(map inc (range 10))`, the symbol `inc`
diff --git a/doc/modules/ROOT/pages/debugging/inspector.adoc
b/doc/modules/ROOT/pages/debugging/inspector.adoc
index fd23fb628dc..9582a46d4fd 100644
--- a/doc/modules/ROOT/pages/debugging/inspector.adoc
+++ b/doc/modules/ROOT/pages/debugging/inspector.adoc
@@ -22,7 +22,7 @@ the last result. This behavior can be controlled with the
variable
TIP: The inspector can also be invoked in the middle of a debugging
session, see xref:debugging/debugger.adoc[here] for more details.
-TIP: The current value of the debugger can be as sent as well to Clojure's
+TIP: The current value of the debugger can be sent as well to Clojure's
`tap>` facility. This can be used to integrate CIDER with various external
tools which render tapped values in a web browser, for example.
@@ -83,7 +83,7 @@ You'll have access to additional keybindings in the inspector
buffer
| kbd:[P]
| `cider-inspector-toggle-pretty-print`
-| Toggle the pretty printing of values in the inspector. You can set the
`cider-inspector-pretty-print` customization option to `t`, if you always want
values to be be pretty printed.
+| Toggle the pretty printing of values in the inspector. You can set the
`cider-inspector-pretty-print` customization option to `t`, if you always want
values to be pretty printed.
| kbd:[S]
| `cider-inspector-toggle-sort-maps`
@@ -119,11 +119,11 @@ You'll have access to additional keybindings in the
inspector buffer
| kbd:[t]
| `cider-inspector-tap-current-val`
-| Performs `tap>` using the inspector's current value as it argument.
+| Performs `tap>` using the inspector's current value as its argument.
| kbd:[1]
| `cider-inspector-tap-at-point`
-| Performs `tap>` using the inspector's current sub-value (the one at POINT)
as it argument.
+| Performs `tap>` using the inspector's current sub-value (the one at POINT)
as its argument.
|===
@@ -140,7 +140,7 @@ can disable the auto selection with the variable
You can set the amount of data shown by default with the variables
`cider-inspector-page-size`, `cider-inspector-max-coll-size`,
`cider-inspector-max-nested-depth`, and `cider-inspector-max-atom-length`. The
-values can be adjusted for the current inspector buffer using the keybidings
+values can be adjusted for the current inspector buffer using the keybindings
listed in the table above.
If you enable `cider-inspector-fill-frame`, the inspector window fills its
diff --git a/doc/modules/ROOT/pages/debugging/logging.adoc
b/doc/modules/ROOT/pages/debugging/logging.adoc
index 1913b0ea0cb..fdd85b4a677 100644
--- a/doc/modules/ROOT/pages/debugging/logging.adoc
+++ b/doc/modules/ROOT/pages/debugging/logging.adoc
@@ -42,7 +42,7 @@ Its usage is mostly self-describing, since each command has
its keybinding attac
== Getting started
-To use CIDER Log Mode, there two main ways to get started:
+To use CIDER Log Mode, there are two main ways to get started:
* `M-x cider-log-show-frameworks`, to see the available logging frameworks. If
your logging framework is supported but not shown, see the troubleshooting
section.
* `M-x cider-log-event`, which uses transient-mode and will not immediately
show the logs (you should use transient-mode to show the `+*cider-log*+` buffer)
@@ -164,7 +164,7 @@ Log4j2 reconfiguration mechanism.
TIP: If your logging framework of choice is not currently supported by CIDER
Log Mode,
you can opt to use Clojure's official `tools.logging` façade in your project,
such that you can locally,
-unobstrusively tell it to use a supported framework (like Logback) instead of
your project's default one.
+unobtrusively tell it to use a supported framework (like Logback) instead of
your project's default one.
Note that its choice of logging backend implementation can be controlled with
the
`-Dclojure.tools.logging.factory` Java system property, which can be cleanly
customized locally via Lein profiles,
or Clojure CLI aliases.
@@ -184,7 +184,7 @@ or Clojure CLI aliases.
| `cider-log-set-buffer`
| kbd:[C-c M-l f b]
-| Select the log buffer to user. Default: `+*cider-log*+`
+| Select the log buffer to use. Default: `+*cider-log*+`
| `cider-log-browse-javadocs`
| kbd:[C-c M-l f j]
@@ -337,7 +337,7 @@ using logical AND condition. The following filters are
available:
| `pattern`
| kbd:[-r]
-| Only include log events whose message matcches the regular expression
`pattern`.
+| Only include log events whose message matches the regular expression
`pattern`.
| `start-time`
| kbd:[-s]
diff --git a/doc/modules/ROOT/pages/debugging/profiling.adoc
b/doc/modules/ROOT/pages/debugging/profiling.adoc
index d7c20a380eb..3659125ac1e 100644
--- a/doc/modules/ROOT/pages/debugging/profiling.adoc
+++ b/doc/modules/ROOT/pages/debugging/profiling.adoc
@@ -1,6 +1,6 @@
= Profiling
-CIDER has a simple built-in profiler that can you to quickly measure the
running
+CIDER has a simple built-in profiler that can help you to quickly measure the
running
time of individual functions. It is similar to wrapping your functions with
`time` macro, except it records every timing and displays a summarized result.
@@ -48,7 +48,7 @@ Let's demystify all the column names:
* `:std`: Standard deviation.
* `:sum`: Aggregate time spent in fn.
* `:min`: Minimal recorded time for fn.
-* `:min`: Maximal recorded time for fn.
+* `:max`: Maximal recorded time for fn.
* `:med`: Median i.e. fiftieth percentile.
* `:samples`: A list of all timing samples. You can click it to see the full
list in the inspector.
diff --git a/doc/modules/ROOT/pages/debugging/tracing.adoc
b/doc/modules/ROOT/pages/debugging/tracing.adoc
index ffbb45fb549..5562e8efba3 100644
--- a/doc/modules/ROOT/pages/debugging/tracing.adoc
+++ b/doc/modules/ROOT/pages/debugging/tracing.adoc
@@ -1,7 +1,7 @@
= Tracing Function Execution
:experimental:
-You can trace the arguments supplied, to and the result values produced
+You can trace the arguments supplied to, and the result values produced
by functions using kbd:[C-c M-t v]. CIDER will prompt you for the
name of the function you want to trace, defaulting to the previous
top-level definition.
diff --git a/doc/modules/ROOT/pages/faq.adoc b/doc/modules/ROOT/pages/faq.adoc
index d732b06f102..d50e8dd5f2f 100644
--- a/doc/modules/ROOT/pages/faq.adoc
+++ b/doc/modules/ROOT/pages/faq.adoc
@@ -91,19 +91,19 @@ There's no precise roadmap, but there are a few major goals
for the (near) futur
You can find more details in our
https://github.com/clojure-emacs/cider/blob/master/ROADMAP.md[roadmap document].
-NOTE: If you'd like to tackle some item from the roadmap, Bozhidar will happy
to help and guide you along the way.
+NOTE: If you'd like to tackle some item from the roadmap, Bozhidar will be
happy to help and guide you along the way.
== Is it true that stable CIDER releases often happen around major Clojure
conferences?
Yep. We want to give people a reason to talk about CIDER at such events. :-)
TIP: Inviting Bozhidar or any other core CIDER developers to present at Clojure
-conferences is likely going to results in more CIDER releases,
+conferences is likely going to result in more CIDER releases,
so you should totally do this!
== How unstable is the MELPA (snapshot) build of CIDER?
-It's pretty stable. Serious regression are introduced rather rarely and are
+It's pretty stable. Serious regressions are introduced rather rarely and are
usually fixed within a few hours. Using the MELPA build gives you early access
to
new features and you're also helping the maintainers with the testing process.
diff --git a/doc/modules/ROOT/pages/platforms/basilisp.adoc
b/doc/modules/ROOT/pages/platforms/basilisp.adoc
index 79d9b519ffd..8f4aa4578be 100644
--- a/doc/modules/ROOT/pages/platforms/basilisp.adoc
+++ b/doc/modules/ROOT/pages/platforms/basilisp.adoc
@@ -19,7 +19,7 @@ There are several ways to connect to Basilisp.
kbd:[M-x cider-jack-in] and kbd:[M-5 M-x cider-jack-in-universal]
-If you have created a `basilisp.edn` project file at your root of your project
tree, you can jack in to the project with `M-x cider-jack-in`. The
`basilisp.edn` is similar to `deps.edn` for clojure-cli projects. It can be
left empty just to mark the root of your project.
+If you have created a `basilisp.edn` project file at the root of your project
tree, you can jack in to the project with `M-x cider-jack-in`. The
`basilisp.edn` is similar to `deps.edn` for clojure-cli projects. It can be
left empty just to mark the root of your project.
If you don't have or want a basilisp project file, you can use universal jack
in with a numerical argument of 5:
@@ -65,14 +65,14 @@ If Basilisp is installed in a virtual environment, update
this to the full path
=== Customization
-There at few ways to setup (custom) variables in Emacs
+There are a few ways to set up (custom) variables in Emacs
==== 1.
https://www.gnu.org/software/emacs/manual/html_node/emacs/Easy-Customization.html[Examining
and Setting Variables]
- kbd:[C-h v cider-basilisp-command], and
- kbd:[C-h v cider-basilisp-parameters]
-==== 2.
https://www.gnu.org/software/emacs/manual/html_node/emacs/Directory-Variables.html[Per-Diretory
Local Variables]
+==== 2.
https://www.gnu.org/software/emacs/manual/html_node/emacs/Directory-Variables.html[Per-Directory
Local Variables]
Uses `.dir-locals.el` to setup per mode variables. This file is typically
stored at the root of the project.
@@ -83,7 +83,7 @@ For example, to set the path to the basilisp executable
within a virtual environ
- Add directory-local variable: `cider-basilisp-command`
- Add `cider-basilisp-command` with value:
`"c:/dev/venvs/312/Scripts/basilisp"`
-This should result to updating or creating a `.dir-local.el` file like below
+This should result in updating or creating a `.dir-locals.el` file like below
[source,lisp]
----
diff --git a/doc/modules/ROOT/pages/platforms/nbb.adoc
b/doc/modules/ROOT/pages/platforms/nbb.adoc
index eee6beeb1d1..e0183a3ac30 100644
--- a/doc/modules/ROOT/pages/platforms/nbb.adoc
+++ b/doc/modules/ROOT/pages/platforms/nbb.adoc
@@ -8,7 +8,7 @@ It is highly compatible with ClojureScript, so it works with
CIDER out of the bo
== Usage
-You can either jack in to an nbb project with `M-x clojure-jack-in-cljs`.
+You can jack in to an nbb project with `M-x cider-jack-in-cljs`,
or start its bundled nREPL server:
diff --git a/doc/modules/ROOT/pages/platforms/other_platforms.adoc
b/doc/modules/ROOT/pages/platforms/other_platforms.adoc
index 34100e61633..fb225c392e1 100644
--- a/doc/modules/ROOT/pages/platforms/other_platforms.adoc
+++ b/doc/modules/ROOT/pages/platforms/other_platforms.adoc
@@ -2,7 +2,7 @@
== Overview
-Here "other platforms" essentially means any (Clojure) platforms that hasn't
+Here "other platforms" essentially means any (Clojure) platforms that haven't
been mentioned specifically earlier in a dedicated section of the
documentation.
As noted earlier in the documentation, down the road CIDER might support
non-Clojure
diff --git a/doc/modules/ROOT/pages/platforms/overview.adoc
b/doc/modules/ROOT/pages/platforms/overview.adoc
index 31cf88d9aef..6c7804d0f25 100644
--- a/doc/modules/ROOT/pages/platforms/overview.adoc
+++ b/doc/modules/ROOT/pages/platforms/overview.adoc
@@ -23,7 +23,7 @@ eventually with more generic versions that dispatch on the
type of the nREPL con
== Current Status
-Right now CIDER the supports to some extent the following:
+Right now CIDER supports to some extent the following:
* xref:platforms/babashka.adoc[Babashka]
* xref:platforms/nbb.adoc[nbb]
@@ -39,4 +39,4 @@ While not a very high priority, making CIDER usable with any
nREPL server is cer
https://github.com/clojure-emacs/cider/issues/2848[Here] you can find a
discussion about the changes needed to
get CIDER to work with Fennel, plus a couple of commits that illustrate them.
-Any help on that front would greatly appreciated!
+Any help on that front would be greatly appreciated!
diff --git a/doc/modules/ROOT/pages/repl/configuration.adoc
b/doc/modules/ROOT/pages/repl/configuration.adoc
index 4a8f7c3a539..355709c8167 100644
--- a/doc/modules/ROOT/pages/repl/configuration.adoc
+++ b/doc/modules/ROOT/pages/repl/configuration.adoc
@@ -90,7 +90,7 @@ following:
== Customizing the `Return` key's behavior
-Ordinarily, kbd:[Return] immediate sends a form for
+Ordinarily, kbd:[Return] immediately sends a form for
evaluation. If you want to insert a newline into the REPL buffer as
you're editing, you can do so using kbd:[C-j]. If you are
entering a lot of longer forms that span multiple lines, it may be
@@ -132,7 +132,7 @@ be displayed you'll need to add the following to your
config:
----
NOTE: This behavior was changed in CIDER 1.7, as the auto-scrolling of output
-before the REPL prompt is rarely needed, but it's current implementation is
very
+before the REPL prompt is rarely needed, but its current implementation is very
slow.
== Auto-trimming the REPL buffer
diff --git a/doc/modules/ROOT/pages/repl/history.adoc
b/doc/modules/ROOT/pages/repl/history.adoc
index 88a34a1a226..bfc83834b14 100644
--- a/doc/modules/ROOT/pages/repl/history.adoc
+++ b/doc/modules/ROOT/pages/repl/history.adoc
@@ -30,7 +30,7 @@ prior to the insertion.
Typically, when you're actively using the REPL, your cursor will be at
the end of the REPL buffer (`point-max`). In this case, the text is
inserted at the end of the buffer and the point advances to the end of
-the inserted text (as if point was pushed by along by the text as it
+the inserted text (as if point was pushed along by the text as it
was inserted).
In the unusual case where you invoke the history browser when your
diff --git a/doc/modules/ROOT/pages/repl/keybindings.adoc
b/doc/modules/ROOT/pages/repl/keybindings.adoc
index 9ed7726a518..aacea235df6 100644
--- a/doc/modules/ROOT/pages/repl/keybindings.adoc
+++ b/doc/modules/ROOT/pages/repl/keybindings.adoc
@@ -30,7 +30,7 @@ kbd:[C-c C-c]
| kbd:[C-up] +
kbd:[C-down]
-| Go to to previous/next input in history.
+| Go to previous/next input in history.
| kbd:[M-p] +
kbd:[M-n]
diff --git a/doc/modules/ROOT/pages/troubleshooting.adoc
b/doc/modules/ROOT/pages/troubleshooting.adoc
index 157b9f9cef1..bd758dad8cb 100644
--- a/doc/modules/ROOT/pages/troubleshooting.adoc
+++ b/doc/modules/ROOT/pages/troubleshooting.adoc
@@ -72,7 +72,7 @@ That's CIDER's way of representing the request (marked with
`+-->+`) and respons
nREPL message logging is not enabled by default. Set `nrepl-log-messages` to
`t`
to activate it. Alternatively you can use kbd:[M-x]
-`nrepl-toggle-message-logging` to enable/disable logging temporary within your
+`nrepl-toggle-message-logging` to enable/disable logging temporarily within
your
current Emacs session. Note that enabling message logging can impact
performance.
@@ -104,7 +104,7 @@ you can step forward until you find the problem.
nREPL message logging is not enabled by default. Set `nrepl-log-messages` to
`t`
to activate it. Alternatively you can use kbd:[M-x]
-`nrepl-toggle-message-logging` to enable/disable logging temporary within your
+`nrepl-toggle-message-logging` to enable/disable logging temporarily within
your
current Emacs session. Note that enabling message logging can impact
performance.
@@ -122,7 +122,7 @@ and copy this information.
=== The REPL blows up when some function returns an URL
Most likely you've encountered some issue with the `content-type` middleware.
Generally, that's
-easy to confirm by inspecting the stracktrace:
+easy to confirm by inspecting the stacktrace:
[source,clojure]
----
@@ -271,7 +271,7 @@ be handled client-side. See
https://github.com/clojure-emacs/cider/issues/2852.
Occasionally the JVM might remove some stack frames, resulting in no stacktrace
information being displayed in CIDER's error buffer.
-That's caused by an JVM optimization (`OmitStackTraceInFastThrow`, enabled by
+That's caused by a JVM optimization (`OmitStackTraceInFastThrow`, enabled by
default), which optimizes "built-in" exceptions that are thrown frequently
enough
to be cached and have no stacktrace.
@@ -351,4 +351,4 @@ that's due to one of the following reasons:
** Session linking generally works by determining whether the current buffer
is related to the classpath of some REPL.
** You can obtain debug info echoed to the `+*Messages*+` buffer by running
`M-x cider-debug-sesman-friendly-session-p` on the problematic buffer.
*** By reading it, you might be able to determine why CIDER failed to see
the relationship between `(buffer-filename)` and the classpath.
- *** Feel free to created a detailed GitHub issue including this information.
+ *** Feel free to create a detailed GitHub issue including this information.
diff --git a/doc/modules/ROOT/pages/usage/cider_mode.adoc
b/doc/modules/ROOT/pages/usage/cider_mode.adoc
index 1353921e93b..2fdc9fda320 100644
--- a/doc/modules/ROOT/pages/usage/cider_mode.adoc
+++ b/doc/modules/ROOT/pages/usage/cider_mode.adoc
@@ -62,7 +62,7 @@ Here's a list of the key bindings of `cider-mode`:
| `cider-eval-last-sexp`
| kbd:[C-x C-e] +
kbd:[C-c C-e]
-| Evaluate the form preceding point and display the result in the echo area
and/or in an buffer overlay (according to `cider-use-overlays`). If invoked
with a prefix argument, insert the result into the current buffer.
+| Evaluate the form preceding point and display the result in the echo area
and/or in a buffer overlay (according to `cider-use-overlays`). If invoked
with a prefix argument, insert the result into the current buffer.
| `cider-eval-last-sexp-and-replace`
| kbd:[C-c C-v w]
@@ -70,7 +70,7 @@ kbd:[C-c C-e]
| `cider-eval-last-sexp-to-repl`
| kbd:[C-c M-e]
-| Evaluate the form preceding point and output it result to the REPL buffer.
If invoked with a prefix argument, takes you to the REPL buffer after being
invoked.
+| Evaluate the form preceding point and output its result to the REPL buffer.
If invoked with a prefix argument, takes you to the REPL buffer after being
invoked.
| `cider-insert-last-sexp-in-repl`
| kbd:[C-c M-p]
diff --git a/doc/modules/ROOT/pages/usage/code_completion.adoc
b/doc/modules/ROOT/pages/usage/code_completion.adoc
index 43e97ae571c..0e9097d3381 100644
--- a/doc/modules/ROOT/pages/usage/code_completion.adoc
+++ b/doc/modules/ROOT/pages/usage/code_completion.adoc
@@ -12,7 +12,7 @@ Improvements to the two libraries automatically translate to
improvements in CID
== Standard completion
-Out-of-the box CIDER uses the standard Emacs tooling for code completion. When
you
+Out-of-the-box CIDER uses the standard Emacs tooling for code completion. When
you
press kbd:[TAB] or kbd:[M-TAB] you'll get completion candidates in a
dedicated buffer.
@@ -166,7 +166,7 @@ following snippet accomplishes that:
(add-to-list 'completion-category-overrides '(cider (styles basic)))
----
-For a better description of how those completion styles operates, refer to the
+For a better description of how those completion styles operate, refer to the
official Emacs manual on
https://www.gnu.org/software/emacs/manual/html_node/emacs/Completion-Styles.html[how
completion alternatives are chosen].
diff --git a/doc/modules/ROOT/pages/usage/code_evaluation.adoc
b/doc/modules/ROOT/pages/usage/code_evaluation.adoc
index 60340e8a7ea..18aa54032bc 100644
--- a/doc/modules/ROOT/pages/usage/code_evaluation.adoc
+++ b/doc/modules/ROOT/pages/usage/code_evaluation.adoc
@@ -25,7 +25,7 @@ As CIDER derives almost all of its functionality by
inspecting the runtime (REPL
of your application, you need to evaluate something before functionality like
code completion,
`eldoc` or definition lookup would work.
-Typically the first think you'd do when visiting a Clojure buffer would be to
load (evaluate) the buffer with `cider-load-buffer` (kbd:[C-c C-k]).
+Typically the first thing you'd do when visiting a Clojure buffer would be to
load (evaluate) the buffer with `cider-load-buffer` (kbd:[C-c C-k]).
Afterwards most of the time you'd be evaluating expressions one at a time
either using
`cider-eval-last-sexp` (kbd:[C-c C-e] or kbd:[C-x C-e]) or
`cider-eval-defun-at-point`
@@ -34,7 +34,7 @@ Afterwards most of the time you'd be evaluating expressions
one at a time either
.What happens if I don't evaluate the entire buffer first?
****
You might be wondering why do you need to evaluate the entire source buffer.
After all,
-won't be it be nice if you could just start evaluating only the forms you're
interested in?
+won't it be nice if you could just start evaluating only the forms you're
interested in?
Technically speaking you're not required to evaluate the entire source buffer
first, but not
doing so introduces some subtleties and a bit of complexity. In general the
only
@@ -133,9 +133,9 @@ eval response was received from nrepl server with status
"done".
nREPL has an asynchronous evaluation model, where eval requests
are enqueued and the responses are sent back to the clients when available.
-This model works great most of the time as doesn't require clients
+This model works great most of the time as it doesn't require clients
to block while waiting for responses, but it also requires the clients
-to able to handle comfortably response callbacks.
+to be able to handle comfortably response callbacks.
Unfortunately, some of Emacs's internal APIs don't play well with asynchronous
evaluation (e.g. completion, eldoc, etc) and in those cases CIDER simulates
@@ -399,7 +399,7 @@ pretty simple - legacy. The principle sources of
inspiration for CIDER, Emacs an
provide more or less the same functionality, but use different keybindings.
CIDER
tried to find a common ground by adopting them both.
-On top of this, at some when it became clear that CIDER has set the world
record
+On top of this, at some point when it became clear that CIDER has set the
world record
for evaluation command, we've introduced a dedicated keymap for all eval
commands
(that's everything with the prefix kbd:[C-c C-v]). This leads to funny
situations
like `cider-eval-defun-at-point` having 3 keybindings:
@@ -410,7 +410,7 @@ like `cider-eval-defun-at-point` having 3 keybindings:
Okay, those are technically 4 keybindings, but who's counting!
-NOTE: Some of you are probably wonder why kbd:[C-c C-v] instead of
+NOTE: Some of you are probably wondering why kbd:[C-c C-v] instead of
kbd:[C-c C-e], right? Again - legacy. Historically kbd:[C-c C-e]
was mapped to `cider-eval-last-sexp`, otherwise we would have picked
this binding. It's still possible to recycle it down the road, as
@@ -425,7 +425,7 @@ Below is a listing of most keybindings for evaluation
commands:
| `cider-eval-last-sexp`
| kbd:[C-x C-e] +
kbd:[C-c C-e]
-| Evaluate the form preceding point and display the result in the echo area
and/or in an buffer overlay (according to `cider-use-overlays`). If invoked
with a prefix argument, insert the result into the current buffer.
+| Evaluate the form preceding point and display the result in the echo area
and/or in a buffer overlay (according to `cider-use-overlays`). If invoked
with a prefix argument, insert the result into the current buffer.
| `cider-tap-last-sexp`
| kbd:[C-c C-v q] +
@@ -438,7 +438,7 @@ kbd:[C-c C-v C-q]
| `cider-eval-last-sexp-to-repl`
| kbd:[C-c M-e]
-| Evaluate the form preceding point and output it result to the REPL buffer.
If invoked with a prefix argument, takes you to the REPL buffer after being
invoked.
+| Evaluate the form preceding point and output its result to the REPL buffer.
If invoked with a prefix argument, takes you to the REPL buffer after being
invoked.
| `cider-insert-last-sexp-in-repl`
| kbd:[C-u C-c M-p]
diff --git a/doc/modules/ROOT/pages/usage/dealing_with_errors.adoc
b/doc/modules/ROOT/pages/usage/dealing_with_errors.adoc
index afb19e0e558..c785033d318 100644
--- a/doc/modules/ROOT/pages/usage/dealing_with_errors.adoc
+++ b/doc/modules/ROOT/pages/usage/dealing_with_errors.adoc
@@ -89,7 +89,7 @@ you can navigate back to `+*cider-error*+` with kbd:[C-x
<left>] (`previous-buff
CIDER comes with a powerful solution for dealing with Clojure
stacktraces. CIDER presents stack traces in a special major mode,
-`cider-stacktrace-mode`, which gives you gives you some key features:
+`cider-stacktrace-mode`, which gives you some key features:
* the ability to filter out certain stack frames to reduce clutter
* some handy ways to navigate to the cause of the exception
diff --git a/doc/modules/ROOT/pages/usage/managing_connections.adoc
b/doc/modules/ROOT/pages/usage/managing_connections.adoc
index 406791d4051..fa3007e297a 100644
--- a/doc/modules/ROOT/pages/usage/managing_connections.adoc
+++ b/doc/modules/ROOT/pages/usage/managing_connections.adoc
@@ -109,7 +109,7 @@ To quit or restart individual connections use CIDER commands
All CIDER commands (evaluation, completion, switching to REPL etc.) operate on
the relevant REPL within the current session. The current session is the most
-relevant session among all linked session (or friendly sessions when no links
+relevant session among all linked sessions (or friendly sessions when no links
exist). Session relevance is decided by the specificity of the linked contexts
and recency of the REPL buffers.
diff --git a/doc/modules/ROOT/pages/usage/misc_features.adoc
b/doc/modules/ROOT/pages/usage/misc_features.adoc
index f601992e620..820f2f15f65 100644
--- a/doc/modules/ROOT/pages/usage/misc_features.adoc
+++ b/doc/modules/ROOT/pages/usage/misc_features.adoc
@@ -45,7 +45,7 @@ The functionality is not perfect, but at least it's there if
you need it. As a b
all of the functions used by some function using `cider-xref-fn-deps`
(kbd:[C-c C-? d]) and `cider-xref-fn-deps-select` (kbd:[C-c C-? C-d]).
Those are pretty handy if you don't want to jump to the source of some
function to see what functions it refers to (uses) internally.
-Don't forget you also have a couple of third-party alternative:
+Don't forget you also have a couple of third-party alternatives:
- The much more sophisticated AST-powered "find usages" provided by
`clj-refactor.el`
- https://github.com/bbatsov/projectile[Projectile's] "grep in project"
(`projectile-grep`, typically bound to kbd:[C-c p g])
@@ -253,7 +253,7 @@ Cider supports the whole mix, but with a twist.
== Formatting Code with cljfmt
-While CIDER has it's own code formatting (indentation) engine, you can also
+While CIDER has its own code formatting (indentation) engine, you can also
use it together with `cljfmt` - that's useful if you're working on a team
that uses different editors and IDEs.
diff --git a/doc/modules/ROOT/pages/usage/working_with_documentation.adoc
b/doc/modules/ROOT/pages/usage/working_with_documentation.adoc
index 87ddf2bdc42..7e631be2c0b 100644
--- a/doc/modules/ROOT/pages/usage/working_with_documentation.adoc
+++ b/doc/modules/ROOT/pages/usage/working_with_documentation.adoc
@@ -2,7 +2,7 @@
Quick access to documentation is very important for productive
development. That's why CIDER puts a heavy emphasis on this
-and provides lot of documentation-related functionality.
+and provides a lot of documentation-related functionality.
== Looking up Documentation
@@ -26,7 +26,7 @@ automatically parse the source file when you query the
documentation for a Java
class (e.g. `java.lang.Thread`) or a method
(e.g. `java.lang.Thread/currentThread`) and will display the properly formatted
JavaDoc in the documentation buffer. You will also see better Eldoc
-documentation (minibuffer hints) for Java methods. If the source file are
+documentation (minibuffer hints) for Java methods. If the source files are
present, you are able to jump to class or method definition by pressing
kbd:[M-.] on the class name or method name.
@@ -50,7 +50,7 @@ retry that until the next restart.
NOTE: While Eldoc functionality benefits from having Java sources, the eldoc
itself will not trigger the downloading of Java source JARs. You will have to
lookup the documentation once manually or jump to the definition in order for
-the JAR is downloaded. After that, Eldoc will pick up the Java sources and
+the JAR to be downloaded. After that, Eldoc will pick up the Java sources and
display better hints.
Alternatively, you can use
@@ -130,7 +130,7 @@ You can change the delimiters that CIDER uses to find
references if
you want to support other reference formats. Simply update the regexp in
`cider-doc-xref-regexp` to match your preferred format. The first
group of the regexp should always match the cross-reference name. For
-example, if you want to want to use Latex-style references
+example, if you want to use Latex-style references
(`+\ref{...}+`) instead, the regexp would be:
----
