docs(completions): document zsh fpath requirement for tab-completion (DX-5783)#41
Open
johnpmitsch wants to merge 1 commit into
Open
docs(completions): document zsh fpath requirement for tab-completion (DX-5783)#41johnpmitsch wants to merge 1 commit into
johnpmitsch wants to merge 1 commit into
Conversation
johnpmitsch
force-pushed
the
dx-completions-zsh-docs
branch
2 times, most recently
from
2fcb020 to
f7024ad
Compare
yorsant
previously approved these changes
Jun 17, 2026
johnpmitsch
force-pushed
the
dx-completions-zsh-docs
branch
from
f7024ad to
5870d4f
Compare
…(DX-5783) Brew installs the completion files, but zsh only autoloads a completion when its directory is on $fpath before compinit runs — so `qn <TAB>` still fell back to filename completion for many zsh users. Document the requirement in the README (both completions sections, linking the zsh manual) and make `qn completions --help` self-documenting with a long_about explaining install-path and zsh nuances plus per-shell install examples. No behavior change to the command itself.
johnpmitsch
force-pushed
the
dx-completions-zsh-docs
branch
from
5870d4f to
0426bc8
Compare
yorsant
approved these changes
Jun 17, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Brew installs the completion files, but zsh only autoloads a completion when its directory is on
$fpathbeforecompinitruns — soqn <TAB>still fell back to filename completion for many zsh users. This documents that requirement; no behavior change to the command.$fpath/compinitrequirement and link the zsh manual; per-shell examples no longer assume an install method.qn completions --help: self-documentinglong_about(install-path + zsh nuances) plus per-shell install examples.Closes DX-5783
Test plan
cargo test,cargo clippy --all-targets -- -D warnings,cargo fmt --checkall passqn completions --helpshows the zsh note + per-shell examples_qninto a dir, add it to$fpathbeforecompinit, open a fresh shell →qn <TAB>completes subcommands