[GitHub] [airflow] mik-laj commented on issue #14283: To capitalise or not to capitalise

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

mik-laj commented on issue #14283:
URL: https://github.com/apache/airflow/issues/14283#issuecomment-786928159


   I try to stick to the rules described in [the Google developer documentation style guide](https://developers.google.com/style/capitalization
   ) and [PEP-8 - Style Guide for Python Code](https://www.python.org/dev/peps/pep-0008/). The first describes the rules for writing documentation and the second describes the class names. 
   
   >. Follow the official capitalization for the names of brands, companies, software, products, services, features, and terms defined by companies and open source communities.
   
   ~ Google developer documentation style guide
   
   > CapitalizedWords (or CapWords, or CamelCase -- so named because of the bumpy look of its letters [4]). This is also sometimes known as StudlyCaps.
   >. 
   > Note: When using acronyms in CapWords, capitalize all the letters of the acronym. Thus HTTPServerError is better than HttpServerError.
   
   ~ PEP-8
   
   > pytest is written with a lowercase p and in some rare cases in with a P
   
   The official project documentation uses the name "pytest" and this is correct.
   <img width="524" alt="Screenshot 2021-02-26 at 23 18 16" src="https://user-images.githubusercontent.com/12058428/109361256-ed79cd00-7888-11eb-97cd-971a0f297275.png">
   Even at the beginning of a sentence, we should use a lowercase letter
   <img width="228" alt="Screenshot 2021-02-26 at 23 18 59" src="https://user-images.githubusercontent.com/12058428/109361319-07b3ab00-7889-11eb-9c59-ccdbfe251dad.png">
   
   > SQLAlchemy turns sometimes into sqlalchemy.
   
   We should use "SQLAlchemy",  if we use the product name, but lowercase if we are referring to the package name.
   
   <img width="593" alt="Screenshot 2021-02-26 at 23 22 43" src="https://user-images.githubusercontent.com/12058428/109361670-ae984700-7889-11eb-96fe-1b077528938a.png">
   
   > Gunicorn into gunicorn. 
   
   We should use "Gunicorn" when referring to the project name, but "gunicorn" when referring to the python package or command name.
   
   > Sometimes you configure Kubernetes sometimes kubernetes.
   
   We should use "Kubernetes" when referring to the project name, but "kubernetes" when referring to the python package.
   


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