airflow-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Joy Gao (JIRA)" <j...@apache.org>
Subject [jira] [Resolved] (AIRFLOW-2131) API Reference includes confusing docs from airflow.utils.AirflowImporter
Date Fri, 23 Feb 2018 03:41:00 GMT

     [ https://issues.apache.org/jira/browse/AIRFLOW-2131?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel
]

Joy Gao resolved AIRFLOW-2131.
------------------------------
       Resolution: Fixed
    Fix Version/s: 1.10.0

Issue resolved by pull request #3062
[https://github.com/apache/incubator-airflow/pull/3062]

> API Reference includes confusing docs from airflow.utils.AirflowImporter
> ------------------------------------------------------------------------
>
>                 Key: AIRFLOW-2131
>                 URL: https://issues.apache.org/jira/browse/AIRFLOW-2131
>             Project: Apache Airflow
>          Issue Type: Bug
>          Components: docs, Documentation
>            Reporter: Reid Beels
>            Assignee: Reid Beels
>            Priority: Critical
>             Fix For: 1.10.0
>
>         Attachments: image-2018-02-20-16-53-04-572.png
>
>
> The generated API documentation includes {{automodule}} declarations for several modules
(hooks and operators) that end up pulling in docs fromĀ {{airflow.utils.helpers.AirflowImporter}}.
> This leads to the confusing situation for new users who think they're reading docs about
what Hooks are, but are instead reading unlabeled docs about the seemingly-deprecated AirflowImporter.
> Like so:
> !image-2018-02-20-16-53-04-572.png!



--
This message was sent by Atlassian JIRA
(v7.6.3#76005)

Mime
View raw message