Skip to content

Normalize multiline help in fish completion output#3313

Closed
monsonego wants to merge 1 commit intopallets:mainfrom
monsonego:fix/fish-multiline-help-completion
Closed

Normalize multiline help in fish completion output#3313
monsonego wants to merge 1 commit intopallets:mainfrom
monsonego:fix/fish-multiline-help-completion

Conversation

@monsonego
Copy link
Copy Markdown

Summary

  • normalize multi-line help text to a single line in fish completion output
  • add an end-to-end regression test covering a multi-line option help string

Why

Fish completion expects each completion entry to stay on one line. When Click includes a help string with embedded newlines, the generated completion output is split across lines and breaks the fish completion script.

Validation

  • PYTHONPATH=src python -m pytest tests/test_shell_completion.py -q

Fixes #3043

@davidism davidism closed this Apr 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.

Multi-line help text is not handled correctly in fish

2 participants