spmallette commented on code in PR #47446:
URL: https://github.com/apache/airflow/pull/47446#discussion_r1983305189


##########
providers/apache/tinkerpop/README.rst:
##########
@@ -0,0 +1,63 @@
+
+.. 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.
+
+.. NOTE! THIS FILE IS AUTOMATICALLY GENERATED AND WILL BE OVERWRITTEN!
+
+.. IF YOU WANT TO MODIFY TEMPLATE FOR THIS FILE, YOU SHOULD MODIFY THE TEMPLATE
+   ``PROVIDER_README_TEMPLATE.rst.jinja2`` IN the 
``dev/breeze/src/airflow_breeze/templates`` DIRECTORY
+
+Package ``apache-airflow-providers-apache-tinkerpop``
+
+Release: ``1.0.0``
+
+
+`Gremlin <https://tinkerpop.apache.org/gremlin.html>`__
+provides hooks to interact with Graph DB using the Gremlin API.

Review Comment:
   If I check in on other Apache related providers, they all appear to just 
read as their trademarked names. I suggest the same for here, simply:
   ```
   `Apache TinkerPop™ <https://tinkerpop.apache.org/>`__.
   ```
   I don't see other providers with a byline, but if we want one and as a 
second suggestion, I think it would be good to use TinkerPop's common byline: 
   > Apache TinkerPop is a graph computing framework for both graph databases 
(OLTP) and graph analytic systems (OLAP) and Gremlin is its graph traversal 
language.
   
   i guess this is a generated file though...........i guess this pulls from 
elsewhere



##########
providers/apache/tinkerpop/README.rst:
##########
@@ -0,0 +1,63 @@
+
+.. 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.
+
+.. NOTE! THIS FILE IS AUTOMATICALLY GENERATED AND WILL BE OVERWRITTEN!
+
+.. IF YOU WANT TO MODIFY TEMPLATE FOR THIS FILE, YOU SHOULD MODIFY THE TEMPLATE
+   ``PROVIDER_README_TEMPLATE.rst.jinja2`` IN the 
``dev/breeze/src/airflow_breeze/templates`` DIRECTORY
+
+Package ``apache-airflow-providers-apache-tinkerpop``
+
+Release: ``1.0.0``
+
+
+`Gremlin <https://tinkerpop.apache.org/gremlin.html>`__
+provides hooks to interact with Graph DB using the Gremlin API.
+
+
+Provider package
+----------------
+
+This is a provider package for ``apache.tinkerpop`` provider. All classes for 
this provider package

Review Comment:
   nit: looking at other Apache providers the initial sentence structure is:
   > This package is for the ``apache.tinkerpop`` provider.
   
   i guess this is a generated file though...........i guess this pulls from 
elsewhere



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

To unsubscribe, e-mail: [email protected]

For queries about this service, please contact Infrastructure at:
[email protected]

Reply via email to