search

microsoft / qsharp-language

Official repository for design of the quantum programming language Q# and its core libraries
MIT License
233 stars 54 forks source link

Fixing incorrect rendering of pipe character #115

Closed SoniaLopezBravo closed 2 years ago

SoniaLopezBravo commented 2 years ago

This closes #352

SoniaLopezBravo commented 2 years ago

@bettinaheim @tcNickolas @cgranade Could you review this? Thanks!

tcNickolas commented 2 years ago

This approach doesn't seem to work when viewing the files on GitHub: looking at https://github.com/microsoft/qsharp-language/blob/740b3427d7be2f8bcba1e9c14675d82b16590143/Specifications/Language/3_Expressions/PrecedenceAndAssociativity.md, it renders as image If we want it to be viewable both in the docs and in the GitHub version of the files, we might have to do some kind of processing in the documentation generation pipeline to account for this difference.

SoniaLopezBravo commented 2 years ago

@tcNickolas I have changed it for another of the possible solutions. This one renders ok on GitHub files, hope it does on the docs page too.

tcNickolas commented 2 years ago

Can you open a pull request with a matching change on the docs repo so that we get a preview to check whether this solution works indeed?

SoniaLopezBravo commented 2 years ago

Can you open a pull request with a matching change on the docs repo so that we get a preview to check whether this solution works indeed?

Hi @tcNickolas. I have created this matching PR, in the preview we see that the pipe character is rendering ok :)

SoniaLopezBravo commented 2 years ago

@bettinaheim could you review this?

bettinaheim commented 2 years ago

I believe this is addressed by the now merged PR https://github.com/microsoft/qsharp-language/pull/124. I'll hence close this.