From c85f438d77ed14c91699aca08e2f85fc5d590519 Mon Sep 17 00:00:00 2001 From: Arthur O'Dwyer Date: Wed, 9 Aug 2023 13:35:58 -0400 Subject: [PATCH] Stop referring to "Examples" in the docs; "Example:" is not supported And "Assertion:" should be "Assert:" --- docs/index.bs | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) diff --git a/docs/index.bs b/docs/index.bs index 6efff91826..55511b7228 100644 --- a/docs/index.bs +++ b/docs/index.bs @@ -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. @@ -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. @@ -2036,7 +2038,7 @@ For the `` tag, it will be replaced by a `` tag in the generated source. The `
` 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