airflow-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Reid Beels (JIRA)" <j...@apache.org>
Subject [jira] [Created] (AIRFLOW-2131) API Reference includes confusing docs from airflow.utils.AirflowImporter
Date Wed, 21 Feb 2018 00:54:00 GMT
Reid Beels created AIRFLOW-2131:
-----------------------------------

             Summary: 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
         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