Doc linkification and :macrocall: improvements #1495
Merged
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
This might seem silly at first glance, but (a) why not consistently link DRM objects, and (b) it removes the most common source of red markup, which I find annoying. (Yes, I should figure out how to fix that for real.)
The old way was to use `.. code-block:: dylan` followed by an example using `*` where it wanted italics. But inside code-block `*` isn't recognized, so this came out looking like lots of global variables. The new way used `.. parsed-literal:: ` (note the trailing space) followed by an example using backquotes to create italics. This has the additional advantage that when editing the source in emacs the italicized parts are colorized, but only when that trailing space is present in the parsed-literal directive! Go figure. (There's some risk that Future Me will compulsively do M-x delete-trailing-whitespace and break that.)
Pointed out by Bruce in dylan-lang#1494, just after I merged it.
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.
Link lots of things and improve the formatting of
:macrocall:markup.Old:
New:
