Skip to content

docs: add shell completion testing section#3247

Closed
mitre88 wants to merge 2 commits intopallets:mainfrom
mitre88:codex/issue-2299-shell-completion-testing-doc
Closed

docs: add shell completion testing section#3247
mitre88 wants to merge 2 commits intopallets:mainfrom
mitre88:codex/issue-2299-shell-completion-testing-doc

Conversation

@mitre88
Copy link

@mitre88 mitre88 commented Mar 5, 2026

Summary

  • add a new Shell Completion section to docs/testing.md
  • document a minimal helper using click.shell_completion.ShellComplete to test completion suggestions directly
  • add an Unreleased changelog entry in CHANGES.rst

This uses the same testing pattern already used in Click's own shell completion tests and gives users a stable migration target from older get_choices-based examples.

Fixes #2299

@davidism davidism closed this Mar 5, 2026
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.

missing documentation: testing of shell completion

2 participants