Skip to content

Document match_description option for custom completions#2185

Merged
fdncred merged 2 commits into
nushell:mainfrom
kiil:docs-match-description-completions
Jun 19, 2026
Merged

Document match_description option for custom completions#2185
fdncred merged 2 commits into
nushell:mainfrom
kiil:docs-match-description-completions

Conversation

@kiil

@kiil kiil commented Jun 18, 2026

Copy link
Copy Markdown
Contributor

Custom completers can now opt into matching the user's prefix against suggestion descriptions in addition to values, by setting match_description: true in the returned options record. The inserted completion is still the suggestion's value.

This PR documents the new option in book/custom_completions.md:

  • Adds match_description to the list of completion options.
  • Adds a "Matching against descriptions" example showing how a value (an email address) can be completed by matching against its description (a person's name).

🤖 Generated with Claude Code

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
@kiil

kiil commented Jun 18, 2026

Copy link
Copy Markdown
Contributor Author

The failing check spelling error is not in my patch.

The spelling error is in another part of the book:

https://www.nushell.sh/book/line_editor.html#abbreviations

@fdncred fdncred merged commit aae655f into nushell:main Jun 19, 2026
2 checks passed
@fdncred

fdncred commented Jun 19, 2026

Copy link
Copy Markdown
Contributor

Thanks

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants