Skip to content

Commit 5f17d0a

Browse files
committed
Improve some documentation
1 parent e848572 commit 5f17d0a

File tree

1 file changed

+11
-14
lines changed

1 file changed

+11
-14
lines changed

doc/modules/ROOT/pages/config/basic_config.adoc

Lines changed: 11 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -83,15 +83,14 @@ To prefer local resources to remote resources (tramp) when both are available:
8383
(setq cider-prefer-local-resources t)
8484
----
8585

86-
== Translate paths
86+
== Translate File Paths
8787

88-
If you wish to translate paths from your running instance you may use
89-
the `cider-path-translations` defcustom to do so. For instance,
90-
suppose your app is running in a docker container with your source
91-
directories mounted. The navigation paths will be relative to the
92-
source in the docker container rather than the correct path on your
93-
host machine. You can add translations easily by setting the
94-
following, most likely in dir locals:
88+
If you wish to translate file paths from your running instance you may use the
89+
`cider-path-translations` defcustom to do so. For instance, suppose your app is
90+
running in a docker container with your source directories mounted there. The
91+
navigation paths you'd get from nREPL will be relative to the source in the
92+
docker container rather than the correct path on your host machine. You can add
93+
translation mappings easily by setting the following (typically in `.dir-locals.el`):
9594

9695
[source,lisp]
9796
----
@@ -101,13 +100,11 @@ following, most likely in dir locals:
101100
---
102101
103102
Each entry will be interpreted as a directory entry so trailing slash
104-
is optional. Navigation will attempt to translate these locations, and
103+
is optional. Navigation to definition will attempt to translate these locations, and
105104
if they exist, navigate there rather than report the file does not
106-
exist. In the example above, the m2 directory is mounted at /root/.m2
107-
and the source at /src. These translations would map these locations
108-
back to the users computer so that navigation would work.
109-
110-
105+
exist. In the example above, the `.m2` directory is mounted at `/root/.m2`
106+
and the source at `/src`. These translations would map these locations
107+
back to the user's computer so that navigation to definition would work.
111108
112109
== Auto-Save Clojure Buffers on Load
113110

0 commit comments

Comments
 (0)