qleroy opened a new issue, #33368:
URL: https://github.com/apache/airflow/issues/33368

   ### What do you see as an issue?
   
   The preview for 
[BREEZE.rst](https://github.com/apache/airflow/blob/main/BREEZE.rst) does not 
show up since #33318.
   
   This is most probably due to the tilde `~` character for marking sections 
that is used in this commit.
   
   [The markup specification for 
sections](https://docutils.sourceforge.io/docs/ref/rst/restructuredtext.html#sections)
 allows for several characters including `~` but it seems that it breaks the 
GitHub preview feature.
   
   Screenshot of the preview being broken:
   
   <img width="814" alt="preview feature broken" 
src="https://github.com/apache/airflow/assets/9881262/3dca3de9-68c5-4ed9-861c-accf6d0abdf1";>
   
   
   ### Solving the problem
   
   The problem can be solved by reverting to a more consensual character like 
`-`.
   
   Screenshot of the preview feature restored after replacing `~` with `-`:
   
   <img width="802" alt="preview feature restored" 
src="https://github.com/apache/airflow/assets/9881262/d1e7c8f8-db77-4423-8a5f-c939d3d4cfce";>
   
   
   ### Anything else
   
   _No response_
   
   ### Are you willing to submit PR?
   
   - [X] Yes I am willing to submit a PR!
   
   ### Code of Conduct
   
   - [X] I agree to follow this project's [Code of 
Conduct](https://github.com/apache/airflow/blob/main/CODE_OF_CONDUCT.md)
   


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