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.

Sign up for GitHub

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

Jump to bottom

[README] Escape vs break comment syntax #207

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

[README] Escape vs break comment syntax #207

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -81,12 +81,12 @@ result blocks.
Result blocks are distinguished in Executable documentation by a custom
expected_similarity comment tag followed by a code block. For example

<!!--expected_similarity=0.8-->
\<!--expected_similarity=0.8-->
<!--expected_similarity=0.8-->
```text
Hello world
```
This example purposely breaks the comment syntax so that it shows up in
In the above example we have escaped the comment syntax so that it shows up in
markdown. Otherwise, the tag of expected_similarity is completely invisible.

The expected similarity value is a floating point number between 0 and 1 which
Expand Down
Loading