You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.
Dismiss alert
The docstring for fastapi.sse.format_sse_event describes the SSE event terminator as \n\n inside backticks. Because the docstring is a regular Python string (not raw), \n is interpreted as a newline at parse time, so the rendered docstring — e.g. via help(format_sse_event) or any generated reference docs — shows two blank lines between empty backticks instead of the intended \n\n escape sequence.
Escaping the backslashes (\\n\\n in source) makes the rendered text match what was intended.
Before
The result always ends with (the event terminator).
After
The result always ends with \n\n (the event terminator).
Comparing AshNicolus:fix/sse-format-docstring-escape (1180fea) with master (99a1b1e)1
Footnotes
No successful run was found on master (91dba44) during the generation of this report, so 99a1b1e was used instead as the comparison base. There might be some changes unrelated to this pull request in this report. ↩
YuriiMotov
changed the title
Fix format_sse_event docstring rendering of \n\n terminator
📝 Fix format_sse_event docstring rendering of \n\n terminator
May 26, 2026
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
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.
Summary
The docstring for fastapi.sse.format_sse_event describes the SSE event terminator as \n\n inside backticks. Because the docstring is a regular Python string (not raw), \n is interpreted as a newline at parse time, so the rendered docstring — e.g. via help(format_sse_event) or any generated reference docs — shows two blank lines between empty backticks instead of the intended \n\n escape sequence.
Escaping the backslashes (\\n\\n in source) makes the rendered text match what was intended.
Before
The result always ends with (the event terminator).
After
The result always ends with \n\n (the event terminator).
Test plan