[GitHub] [airflow] mik-laj commented on a change in pull request #10396: Improve headings on docs/executor

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

mik-laj commented on a change in pull request #10396:
URL: https://github.com/apache/airflow/pull/10396#discussion_r472947863



##########
File path: docs/executor/index.rst
##########
@@ -36,6 +36,9 @@ the example below.
     $ airflow config get-value core executor
     SequentialExecutor
 
+Supported backends
+^^^^^^^^^^^^^^^^^^

Review comment:
       From Sphinx docs:
   
   > Normally, there are no heading levels assigned to certain characters as the structure is determined from the succession of headings.
   
   Unless we can force it with a pre-commit check and It doesn't affect the final result, I don't care what specific character. The user's perspective is important to me.  Our environment is too open for this rule to be enforced in any other way. There will still be changes to the documentation that do not follow the convention. 
   Before structure: 
   <img width="389" alt="Screenshot 2020-08-19 at 12 57 08" src="https://user-images.githubusercontent.com/12058428/90626673-9204bd80-e21b-11ea-938c-995d1efa2d33.png">
   
   And when it comes to case, it is also not standardized in this project. Elsewhere in the documentation, we have a similar lowercase header.
   <img width="524" alt="Screenshot 2020-08-19 at 12 57 23" src="https://user-images.githubusercontent.com/12058428/90626870-ba8cb780-e21b-11ea-81c2-da5abe0cae32.png">
   I will gladly correct it here.




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