You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@airflow.apache.org by "kalluripradeep (via GitHub)" <gi...@apache.org> on 2026/01/24 14:26:41 UTC

[PR] Fix #60996: Add missing links to airflow.sdk classes and functions in public interface docs [airflow]

kalluripradeep opened a new pull request, #61005:
URL: https://github.com/apache/airflow/pull/61005

   Fixes #60996
   
   ## Problem
   The public interface documentation page had several issues:
   1. First sentence linked to TaskFlow docs instead of proper airflow.sdk namespace documentation
   2. All 15 classes listed (Asset, BaseHook, BaseOperator, etc.) had no links
   3. All 11 decorators/functions (@asset, @dag, chain, etc.) had no links
   
   This made it difficult for DAG authors to discover the proper API documentation.
   
   ## Solution
   1. Updated first sentence to link to Task SDK Reference documentation
   2. Added `:class:` links for all 15 classes pointing to `airflow.sdk.*`
   3. Added `:func:` links for all 11 decorators and functions pointing to `airflow.sdk.*`
   
   ## Changes
   - Updated line 90: Changed `:doc:` link to proper Task SDK Reference external link
   - Lines 99-111: Added `:class:` Sphinx directives for all classes
   - Lines 118-128: Added `:func:` Sphinx directives for all decorators and functions
   
   ## Testing
   - Built documentation locally to verify all links resolve correctly
   - Verified link format matches existing Task SDK documentation patterns
   - Checked that all 26 items (15 classes + 11 functions) now have working links
   
   ## Related
   - Addresses feedback from @fritz-astronomer and @Varshitha9115
   - Improves discoverability of airflow.sdk namespace for DAG authors


-- 
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: commits-unsubscribe@airflow.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


Re: [PR] Add missing links to airflow.sdk classes and functions in public interface docs [airflow]

Posted by "shahar1 (via GitHub)" <gi...@apache.org>.
shahar1 merged PR #61005:
URL: https://github.com/apache/airflow/pull/61005


-- 
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: commits-unsubscribe@airflow.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


Re: [PR] Add missing links to airflow.sdk classes and functions in public interface docs [airflow]

Posted by "kalluripradeep (via GitHub)" <gi...@apache.org>.
kalluripradeep commented on PR #61005:
URL: https://github.com/apache/airflow/pull/61005#issuecomment-3794895593

   > Please fix failing static checks
   
   @shahar1 done, Thank you


-- 
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: commits-unsubscribe@airflow.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


Re: [PR] Add missing links to airflow.sdk classes and functions in public interface docs [airflow]

Posted by "github-actions[bot] (via GitHub)" <gi...@apache.org>.
github-actions[bot] commented on PR #61005:
URL: https://github.com/apache/airflow/pull/61005#issuecomment-3795317384

   ### Backport successfully created: v3-1-test
   
   <table>
                   <tr>
                       <th>Status</th>
                       <th>Branch</th>
                       <th>Result</th>
                   </tr>
                   <tr>
                       <td>✅</td>
                       <td>v3-1-test</td>
                       <td><a href="https://github.com/apache/airflow/pull/61012"><img src="https://img.shields.io/badge/PR-61012-blue" alt="PR Link"></a></td>
                   </tr>
               </table>


-- 
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: commits-unsubscribe@airflow.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org