mik-laj commented on issue #4672: [AIRFLOW-XXX] Move out the examples from integration.rst URL: https://github.com/apache/airflow/pull/4672#issuecomment-461901970 Currently, examples can be in two places - docstring for classes and `howto/operator.rst` file. If it's just simple an example code, it's good when it's in the class description. If a longer description is needed, then I think that the `howto / operaotr.rst` file is a better place. In the future, however, you should choose only one and used. I note that both places are connected with links: https://github.com/apache/airflow/pull/4671 I do not think that an additional explanation is necessary. When someone opens this integration.rst file, the purpose of this file is legible for him. I prepared a preview for you: http://glistening-theory.surge.sh/integration.html I cleaned the integration.rst file from unwanted things earlier. If you want me to add a note in the file `howto/operator.rst` or class descriptions, it is also not necessary. These two places require a general improvement, not just a small, simple improvement. I think that before unification operator's documentation, we need to resolve other issues https://issues.apache.org/jira/browse/AIRFLOW-3811 (this issues creates a new subpage for each class) It is also useful to resolve another issues, but it's not required https://github.com/apache/airflow/pull/4667 (I invite you to the discussion. Read the description carefully, not just the title. This is a big change for Airflow. I am collecting opinions about this change. Based on the opinion, I will propose a general improvement plan. )
---------------------------------------------------------------- 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: [email protected] With regards, Apache Git Services
