[GitHub] [airflow] mik-laj commented on a change in pull request #5729: [AIRFLOW-XXX] Fix incorrect docstring parameter

[GitBox <gi...@apache.org>]

mik-laj commented on a change in pull request #5729: [AIRFLOW-XXX] Fix incorrect docstring parameter
URL: https://github.com/apache/airflow/pull/5729#discussion_r310827005
 
 

 ##########
 File path: airflow/jobs/scheduler_job.py
 ##########
 @@ -65,8 +65,8 @@ def __init__(self, file_path, pickle_dags, dag_id_white_list):
         :type file_path: unicode
         :param pickle_dags: whether to serialize the DAG objects to the DB
         :type pickle_dags: bool
-        :param dag_id_whitelist: If specified, only look at these DAG ID's
-        :type dag_id_whitelist: list[unicode]
+        :param dag_id_white_list: If specified, only look at these DAG ID's
+        :type dag_id_white_list: list[unicode]
 
 Review comment:
   Can you move the parameter description to the class description?  It is not correct to have a separate class description and constructor. Sphinx does not support this properly.

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


With regards,
Apache Git Services