You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@airflow.apache.org by GitBox <gi...@apache.org> on 2021/04/16 14:44:45 UTC

[GitHub] [airflow] marcosmarxm commented on a change in pull request #15393: Add Connection Documentation for Popular Providers

marcosmarxm commented on a change in pull request #15393:
URL: https://github.com/apache/airflow/pull/15393#discussion_r614892162



##########
File path: docs/apache-airflow-providers-mongo/connections/mongo.rst
##########
@@ -0,0 +1,82 @@
+.. Licensed to the Apache Software Foundation (ASF) under one
+    or more contributor license agreements.  See the NOTICE file
+    distributed with this work for additional information
+    regarding copyright ownership.  The ASF licenses this file
+    to you under the Apache License, Version 2.0 (the
+    "License"); you may not use this file except in compliance
+    with the License.  You may obtain a copy of the License at
+
+ ..   http://www.apache.org/licenses/LICENSE-2.0
+
+ .. Unless required by applicable law or agreed to in writing,
+    software distributed under the License is distributed on an
+    "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+    KIND, either express or implied.  See the License for the
+    specific language governing permissions and limitations
+    under the License.
+
+
+
+.. _howto/connection:mongo:
+
+MongoDB Connection
+==================
+
+The MongoDB connection type enables the MongoDB Integrations.

Review comment:
       I think you need to add MongoDB to spelling words too

##########
File path: airflow/providers/cncf/kubernetes/operators/spark_kubernetes.py
##########
@@ -34,8 +34,9 @@ class SparkKubernetesOperator(BaseOperator):
     :type application_file:  str
     :param namespace: kubernetes namespace to put sparkApplication
     :type namespace: str
-    :param kubernetes_conn_id: the connection to Kubernetes cluster
-    :type kubernetes_conn_id: str
+    :param conn_id: The :ref:`kubernetes connection<howto/connection:kubernetes>`

Review comment:
       ```suggestion
       :param kubernetes_conn_id: The :ref:`kubernetes connection<howto/connection:kubernetes>`
   ```
   because the parameter keep the name or you want to change it?

##########
File path: airflow/providers/apache/spark/hooks/spark_jdbc.py
##########
@@ -31,7 +31,8 @@ class SparkJDBCHook(SparkSubmitHook):
 
     :param spark_app_name: Name of the job (default airflow-spark-jdbc)
     :type spark_app_name: str
-    :param spark_conn_id: Connection id as configured in Airflow administration
+    :param spark_conn_id: The :ref:`spark connection id<howto/connection:spark>`

Review comment:
       ```suggestion
       :param spark_conn_id: The :ref:`spark connection id <howto/connection:spark>`
   ```

##########
File path: airflow/providers/mongo/sensors/mongo.py
##########
@@ -34,9 +34,9 @@ class MongoSensor(BaseSensorOperator):
     :type collection: str
     :param query: The query to find the target document.
     :type query: dict
-    :param mongo_conn_id: The connection ID to use
+    :param mongo_conn_id: The :ref:`Mongo connection ID<howto/connection:mongo>` to use
         when connecting to MongoDB.
-    :type mongo_conn_id: str
+    :type mongo: str

Review comment:
       ```suggestion
       :type mongo_conn_id: str
   ```




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