Keep message queue provider doc markers out of class docstrings - #73588
Merged
vincbeck merged 1 commit intoSep 23, 2026
Merged
Conversation
boring-cyborg
Bot
added
area:providers
kind:documentation
provider:amazon
10 tasks
aaron-y-chen
marked this pull request as ready for review
September 23, 2026 01:30
aaron-y-chen
requested review from
dabla,
o-nikolas and
shahar1
as code owners
September 23, 2026 01:30
vincbeck
approved these changes
Sep 23, 2026
vincbeck
left a comment
vincbeck
left a comment
Contributor
There was a problem hiding this comment.
Nice! Thanks for the cleanup
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 join this conversation on GitHub.
Already have an account?
Sign in to comment
2 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.
related: #73509
related: #52712
While I was working on #73509, a bug was found in the docs.
Summary
Six message queue provider classes put Sphinx
[START]/[END]doc markers inside the class docstring. The docstring leaves the module through two paths and only one of them strips the markers, so they are rendered as literal text on the published API reference pages, and are returned byhelp()and shown in IDE tooltips.Live example:
SqsMessageQueueProvider:The same is visible today on the Kafka, Redis, Azure Service Bus and Pub/Sub API pages.
Was generative AI tooling used to co-author this PR?
Generated-by: [Claude Opus-5] following the guidelines
{pr_number}.significant.rst, in airflow-core/newsfragments. You can add this file in a follow-up commit after the PR is created so you know the PR number.