aaron-y-chen opened a new pull request, #73588:
URL: https://github.com/apache/airflow/pull/73588

   related: #73509
   
   ## 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 by `help()` 
and shown in IDE tooltips.
   
   Live example: 
[`SqsMessageQueueProvider`](https://airflow.apache.org/docs/apache-airflow-providers-amazon/stable/_api/airflow/providers/amazon/aws/queues/sqs/index.html#module-contents):
   
   <img width="1729" height="986" alt="kinesis_follow_up_1" 
src="https://github.com/user-attachments/assets/ad1d2e23-4a57-4042-8bab-058a824f10a8";
 />
   
   <br><br>
   
   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?
   
   <!--
   If generative AI tooling has been used in the process of authoring this PR, 
please
   change below checkbox to `[X]` followed by the name of the tool, uncomment 
the "Generated-by".
   -->
   
   - [x] Yes (please specify the tool below)
   
   Generated-by: [Claude Opus-5] following [the 
guidelines](https://github.com/apache/airflow/blob/main/contributing-docs/05_pull_requests.rst#gen-ai-assisted-contributions)
   
   ---
   
   * Read the **[Pull Request 
Guidelines](https://github.com/apache/airflow/blob/main/contributing-docs/05_pull_requests.rst#pull-request-guidelines)**
 for more information. Note: commit author/co-author name and email in commits 
become permanently public when merged.
   * For fundamental code changes, an Airflow Improvement Proposal 
([AIP](https://cwiki.apache.org/confluence/display/AIRFLOW/Airflow+Improvement+Proposals))
 is needed.
   * When adding dependency, check compliance with the [ASF 3rd Party License 
Policy](https://www.apache.org/legal/resolved.html#category-x).
   * For significant user-facing changes create newsfragment: 
`{pr_number}.significant.rst`, in 
[airflow-core/newsfragments](https://github.com/apache/airflow/tree/main/airflow-core/newsfragments).
 You can add this file in a follow-up commit after the PR is created so you 
know the PR number.
   


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: [email protected]

For queries about this service, please contact Infrastructure at:
[email protected]

Reply via email to