Fix: Ensure fish completion handles multiline help strings correctly#3126
Merged
Conversation
Collaborator
|
Thanks again for these fixes, apologies it took us a bit longer. Thanks as well @Rowlando13 for the rebase! |
kdeldycke
added a commit
to kdeldycke/click
that referenced
this pull request
Apr 30, 2026
Link to PR in changelog, move implementation details to Python code, fix changed version and align `.gitignore` syntax
Collaborator
|
@AndreasBackx you missed some details about the documentation. I fixed them in: c07cd75 (part of #3393). |
kdeldycke
added a commit
to kdeldycke/click
that referenced
this pull request
May 8, 2026
Link to PR in changelog, move implementation details to Python code, fix changed version and align `.gitignore` syntax
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 subscribe to this conversation on GitHub.
Already have an account?
Sign in.
3 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.
This pull request addresses issue #3043 by correctly handling multiline help strings when generating shell completion scripts for the fish shell.
Problem:
Previously, commands with multiline help text would cause errors or incorrect completion behavior in fish shell due to improper escaping of newlines within the help strings.
Changes:
src/click/shell_completion.pyto correctly escape newline characters (\n) within help texts before outputting them to the fish completion script.tests/test_shell_completion.py::test_fish_multiline_help_completeto specifically verify that multiline help strings are processed correctly and do not cause errors.CHANGES.rstfile has been updated to include this fix, referencing issue Multi-line help text is not handled correctly in fish #3043..gitignorefile was also updated as part of the pre-commit hooks.fixes #3043