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

["ASF GitHub Bot (Jira)" <ji...@apache.org>]

    [ https://issues.apache.org/jira/browse/AIRFLOW-5497?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16949998#comment-16949998 ] 

ASF GitHub Bot commented on AIRFLOW-5497:
-----------------------------------------

chicochico commented on pull request #6314: [AIRFLOW-5497] Update docstring with param description
URL: https://github.com/apache/airflow/pull/6314
 
 
   Make sure you have checked _all_ steps below.
   
   ### Jira
   
   - [x] My PR addresses the following [Airflow Jira](https://issues.apache.org/jira/browse/AIRFLOW/) issues and references them in the PR title. For example, "\[AIRFLOW-XXX\] My Airflow PR"
     - https://issues.apache.org/jira/browse/AIRFLOW-XXX
     - In case you are fixing a typo in the documentation you can prepend your commit with \[AIRFLOW-XXX\], code changes always need a Jira issue.
     - In case you are proposing a fundamental code change, you need to create an Airflow Improvement Proposal ([AIP](https://cwiki.apache.org/confluence/display/AIRFLOW/Airflow+Improvements+Proposals)).
     - In case you are adding a dependency, check if the license complies with the [ASF 3rd Party License Policy](https://www.apache.org/legal/resolved.html#category-x).
   
   ### Tests
   
   - [ ] My PR adds the following unit tests __OR__ does not need testing for this extremely good reason: Documentation change
   
   ### Commits
   
   - [x] My commits all reference Jira issues in their subject lines, and I have squashed multiple commits if they address the same issue. In addition, my commits follow the guidelines from "[How to write a good git commit message](http://chris.beams.io/posts/git-commit/)":
     1. Subject is separated from body by a blank line
     1. Subject is limited to 50 characters (not including Jira issue reference)
     1. Subject does not end with a period
     1. Subject uses the imperative mood ("add", not "adding")
     1. Body wraps at 72 characters
     1. Body explains "what" and "why", not "how"
 
----------------------------------------------------------------
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.
 
For queries about this service, please contact Infrastructure at:
users@infra.apache.org


> 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
>            Priority: Minor
>              Labels: ccoss2019, newbie
>
> 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.4#803005)