docs: make example margin notes read as plain prose#3248
Open
bartlomieju wants to merge 1 commit into
Open
Conversation
This file contains hidden or 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
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.
The two-column example layout renders commentary as italic, right-aligned
margin notes beside the code. Feedback on the recent example batches was
that this reads strangely: the right alignment makes paragraphs ragged on
the left edge and the italics tire the eye over a long page.
This PR is the conservative counterpart to #3247 (pick one). It keeps the
two-column structure, so the at-a-glance density of the current pages is
unchanged, and only restyles the notes: plain upright text, left aligned,
secondary foreground color, relaxed line height, and a small top offset
to align the first line with the code beside it. The diff is a single
class change in SnippetComponent.
Before:
After (refined two-column):