[jira] [Created] (AIRFLOW-5497) dag_processing::list_py_file_paths method pydoc needs param added

["Jakob Homan (Jira)" <ji...@apache.org>]

Jakob Homan created AIRFLOW-5497:
------------------------------------

             Summary: dag_processing::list_py_file_paths method pydoc needs param added
                 Key: AIRFLOW-5497
                 URL: https://issues.apache.org/jira/browse/AIRFLOW-5497
             Project: Apache Airflow
          Issue Type: Bug
          Components: utils
    Affects Versions: 1.10.6
            Reporter: Jakob Homan


Note: This ticket's being created to facilitate a new contributor's workshop for Airflow. After the workshop has completed, I'll mark these all available for anyone that might like to take them on.

The {{list_py_file_paths}} method pydoc is missing an entry for the {{include_examples}} parameter.  We should add it.

airflow/utils/dag_processing.py:291
{code:java}
def list_py_file_paths(directory, safe_mode=conf.getboolean('core', 'DAG_DISCOVERY_SAFE_MODE', fallback=True),
                       include_examples=None):
    """
    Traverse a directory and look for Python files.

    :param directory: the directory to traverse
    :type directory: unicode
    :param safe_mode: whether to use a heuristic to determine whether a file
        contains Airflow DAG definitions. If not provided, use the
        core.DAG_DISCOVERY_SAFE_MODE configuration setting. If not set, default
        to safe.
    :return: a list of paths to Python files in the specified directory
    :rtype: list[unicode] {code}



--
This message was sent by Atlassian Jira
(v8.3.2#803003)