Bowrna commented on pull request #20066:
URL: https://github.com/apache/airflow/pull/20066#issuecomment-993845963


   I am trying to add docs for BREEZE and I am getting the below error
   ```
   Only capitalized Breeze used in 
Breeze2..................................................Failed
   - hook id: capitalized-breeze
   - exit code: 1
   
   dev/breeze/doc/BREEZE2.md:26:- [Updated BREEZE](#updated-breeze)
   dev/breeze/doc/BREEZE2.md:27:- [BREEZE setting up 
autocomplete](#breeze-setting-up-autocomplete)
   ```
   This is the actual doc content.
   ```
   Here we are, introducing the post about BREEZE (Updated BREEZE version). 
It's going to be great!
   But first: Created a TOC for easy reference about BREEZE commands
   
   <!-- START doctoc generated TOC please keep comment here to allow auto 
update -->
   <!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
   
   - [Updated BREEZE](#updated-breeze)
   - [BREEZE setting up autocomplete](#breeze-setting-up-autocomplete)
   
   <!-- END doctoc generated TOC please keep comment here to allow auto update 
-->
   
   # Updated BREEZE
   
   Here we'll discuss about BREEZE...
   
   # BREEZE setting up autocomplete
   
   To setup autocomplete for BREEZE that helps you to autocomplete the list of 
commands that BREEZE supports with tab completion.
   ```
   TOC is autogenerated by doctoc and it creates the link to content by 
converting the title to lowercase. This violates the pre-commit rule to 
capitalize the BREEZE that is added. How do you think this could be handled?


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