Fix macro references in Bikeshed documentation #2773
Closed
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Since 16c53d7 the syntax '`[MACRO]`' is no longer protected from replacement, and an escaped '`\[MACRO]`' reference will be output as '`<code>\[MACRO]</code>`'. So, replace all '`[MACRO]`' references with '`<code>\[MACRO]</code>`' in the bikeshed source, which is correctly translated into the output document as '`<code>[MACRO]</code>`'.
|
Ironically, the only reference that doesn't have to be adjusted is this one: Line 4138 in c20becf As the new behavior is the same as the old behavior in that particular instance. |
|
This problem doesn't reproduce in the current version of Bikeshed. I have to assume the issue is the docs being generated with an old version. |
Agreed, though I don't know how as I was working in a venv with a *shrug* Oh, well. Apologies for the noise. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Since 16c53d7 the syntax
`[MACRO]`is no longer protected from replacement, and an escaped`\[MACRO]`reference will be output as<code>\[MACRO]</code>.So, replace all
`[MACRO]`references with<code>\[MACRO]</code>in the bikeshed documentation source, which is correctly translated into the output document as<code>[MACRO]</code>.The regenerated
docs/index.html(included) differs only by code changes made to bikeshed's HTML generation boilerplate since the last time it was generated.Affects #2765 (specifically, the
docs/index.htmlgenerated there)