[GitHub] ashb commented on a change in pull request #3712: [AIRFLOW-2864] Fix docstrings for SubDagOperator

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

ashb commented on a change in pull request #3712: [AIRFLOW-2864] Fix docstrings for SubDagOperator
URL: https://github.com/apache/incubator-airflow/pull/3712#discussion_r208243635
 
 

 ##########
 File path: airflow/operators/subdag_operator.py
 ##########
 @@ -37,18 +49,6 @@ def __init__(
             subdag,
             executor=SequentialExecutor(),
             *args, **kwargs):
-        """
-        This runs a sub dag. By convention, a sub dag's dag_id
-        should be prefixed by its parent and a dot. As in `parent.child`.
-
-        :param subdag: the DAG object to run as a subdag of the current DAG.
-        :type subdag: airflow.DAG.
-        :param dag: the parent DAG for the subdag.
-        :type dag: airflow.DAG.
-        :param executor: the executor for this subdag. Default to use SequentialExecutor.
-                         Please find AIRFLOW-74 for more details.
-        :type executor: airflow.executors.
-        """
 
 Review comment:
   Curious. I thought sphinx looked here for class-level docs. I guess not!

----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on 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