Skip to content

docs: show how to test shell completion#3633

Open
Uomocapra wants to merge 21 commits into
pallets:stablefrom
Uomocapra:codex/docs-shell-completion-tests
Open

docs: show how to test shell completion#3633
Uomocapra wants to merge 21 commits into
pallets:stablefrom
Uomocapra:codex/docs-shell-completion-tests

Conversation

@Uomocapra

Copy link
Copy Markdown

Summary

  • Add a testing guide section for shell completion.
  • Show how to call ShellComplete.get_completions directly in tests.
  • Note when to use CliRunner.invoke for shell-specific completion output.

Closes #2299.

Checks

  • git diff --check
  • Ran the documented completion example against the local src package.
  • sphinx-build -E -W -b dirhtml docs docs\_build\dirhtml

@kdeldycke kdeldycke changed the base branch from main to stable June 25, 2026 06:52
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

8 participants