Stop referring to "Examples" in the docs; "Example:" is not supported #2632
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This patch is not ready for prime time, as indicated by the
[TODO FIXME WHAT GOES HERE]
. But I hope it's somewhat useful.I wanted to add an "Example:" block to a C++ paper — basically a "Note:" but with the implication that readers might as well just skip over it if they don't care. The documentation for Bikeshed has a section on "... Examples, ..." — but the section title seems to be a lie: Bikeshed doesn't support
Example:
markup in anything like the way it does forNote:
orIssue:
.I do wonder if
Assert:
is intended to be kind of like an "Example." But of course I don't want my paper to actually say the word "Assert:" inside the gray box. So I'll use some custom div styling, probably.I have not checked whether the
.example
class actually exists (the doc says it does), but I have definitely checked that the .bs syntaxExample:
doesn't trigger it.