jon.recoil.org
Odoc docs
docs: use `opam var odoc-switchdocs:share` for the completion fpath
Cleaner and layout-robust than hardcoding $OPAM_SWITCH_PREFIX/share/...
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
author
Jon Ludlam's Agent
co-author
Claude Opus 4.8 (1M context)
committer
Jon Ludlam
date
(Jun 23, 2026, 2:30 PM +0100)
commit
caf9a75c
caf9a75c007446da1c347e3089a20f4ad72c9b9a
parent
15a4faa0
15a4faa08d88ac6da4d0813ca2bbc0e64e544c02
+5
-6
+3
-4
README.md
+3
-4
README.md
···
59
59
(`Stdlib` open, package-qualified `/pkg/...` paths, kind tags like `type-`,
60
60
section labels, …). Type `.` or `/` and press TAB again to drill in.
61
61
62
-
`opam install` puts it under `$OPAM_SWITCH_PREFIX/share/odoc-switchdocs/zsh`.
63
-
That directory isn't on zsh's `$fpath` by default, so add it (before
64
-
`compinit`) in `~/.zshrc`:
62
+
`opam install` puts it under the package's share dir. That directory isn't on
63
+
zsh's `$fpath` by default, so add it (before `compinit`) in `~/.zshrc`:
65
64
66
65
```zsh
67
-
fpath=("$OPAM_SWITCH_PREFIX/share/odoc-switchdocs/zsh" $fpath)
66
+
fpath=("$(opam var odoc-switchdocs:share)/zsh" $fpath)
68
67
autoload -U compinit && compinit
69
68
```
70
69
+2
-2
completions/zsh/_switchdocs
+2
-2
completions/zsh/_switchdocs
···
3
3
# zsh completion for switchdocs.
4
4
#
5
5
# Install: put this file's directory on $fpath before compinit. After
6
-
# `opam install` it lives under the switch's share dir; add to ~/.zshrc:
6
+
# `opam install` it lives under the package's share dir; add to ~/.zshrc:
7
7
#
8
-
# fpath=("$OPAM_SWITCH_PREFIX/share/odoc-switchdocs/zsh" $fpath)
8
+
# fpath=("$(opam var odoc-switchdocs:share)/zsh" $fpath)
9
9
# autoload -U compinit && compinit
10
10
#
11
11
# (or point $fpath at completions/zsh in a source checkout.)