Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Preview feature broken for ./BREEZE.rst #33368

Closed
2 tasks done
qleroy opened this issue Aug 13, 2023 · 2 comments
Closed
2 tasks done

Preview feature broken for ./BREEZE.rst #33368

qleroy opened this issue Aug 13, 2023 · 2 comments
Labels
kind:bug This is a clearly a bug kind:documentation

Comments

@qleroy
Copy link
Contributor

qleroy commented Aug 13, 2023

What do you see as an issue?

The preview for 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 allows for several characters including ~ but it seems that it breaks the GitHub preview feature.

Screenshot of the preview being broken:

preview feature broken

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

preview feature restored

Anything else

No response

Are you willing to submit PR?

  • Yes I am willing to submit a PR!

Code of Conduct

@qleroy qleroy added kind:bug This is a clearly a bug kind:documentation needs-triage label for new issues that we didn't triage yet labels Aug 13, 2023
@boring-cyborg
Copy link

boring-cyborg bot commented Aug 13, 2023

Thanks for opening your first issue here! Be sure to follow the issue template! If you are willing to raise PR to address this issue please do so, no need to wait for approval.

@phanikumv phanikumv removed the needs-triage label for new issues that we didn't triage yet label Aug 14, 2023
@phanikumv
Copy link
Contributor

Closing as #33369 has been merged.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
kind:bug This is a clearly a bug kind:documentation
Projects
None yet
Development

No branches or pull requests

2 participants