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

Stop referring to "Examples" in the docs; "Example:" is not supported #2632

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

Stop referring to "Examples" in the docs; "Example:" is not supported #2632

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
10 changes: 6 additions & 4 deletions docs/index.bs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1683,13 +1683,13 @@ More of Markdown will be supported in the future,
as I get closer to adhering to the CommonMark specification.


Notes, Issues, Examples, Advisements {#notes-etc}
Notes, Issues, Assertions, Advisements {#notes-etc}
-------------------------------------------------

The Markdown processor specially recognizes paragraphs starting with
"Issue: ",
"Advisement: ",
"Assertion: ",
"Assert: ",
"Note: ",
or "Note, ",
and will add a matching class to the paragraph automatically.
Expand All @@ -1701,7 +1701,9 @@ so make sure you provide your own styling if you change them.)

The default styling of these blocks includes a generated-content "header"
containing the word "NOTE:", etc.
Elements with the `.example` class will also be given a generated-content "header"

Elements with the `.example` class (which must be manually added via [TODO FIXME WHAT GOES HERE])
will also be given a generated-content "header"
in the format `EXAMPLE n`
with an auto-incrementing number,
and have self-links created to allow linking directly to the example.
Expand Down Expand Up @@ -2036,7 +2038,7 @@ For the `<assert>` tag, it will be replaced by a `<span>` tag in the generated
source. The `<div>` tag will pass through but the `assert` attribute is removed.

In both cases a unique ID is generated from the tags contents of the form "assert-###",
where "###" is a substring of a hash of the assertions contents.
where "###" is a substring of a hash of the assertion's contents.
This ensures that you have a unique ID that won't change arbitrarily,
but *will* change **when the contents of the assertion change**,
making it easier to tell when a test might no longer be testing the assertion it points to
Expand Down