Documentation: Clarify block conventions#16458
Merged
Merged
Conversation
mkaz
reviewed
Jul 8, 2019
c4e6779 to
2d112e7
Compare
Vaguely related: #16002.
Co-Authored-By: Marcus Kazmierczak <marcus@mkaz.com>
2d112e7 to
dfb25f3
Compare
This was referenced Jun 16, 2025
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
3 participants
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.
In response to confusion in #16118 and #16002, this introduces two small documentation changes to be more explicit about the conventions we follow:
I tried to be as clear and succinct as possible here, but I'm natually wordy (and I think examples are probably extremely helpful here). If there are bits we can clarify or trim down, happy to revise!