[TASK] Document when a caption marks an excerpt - #566
Merged
Merged
Conversation
The caption rule says to name the file the example goes into, but not what to do when the block is only part of that file — which is most of the longer examples in the manuals. A reader who copies such a block into a new file of that name loses everything around it. Assisted-by: Claude Opus 5 <noreply@anthropic.com> Signed-off-by: Lina Wolf
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
1 participant
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 caption rule says to name the file the example goes into, but not
what to do when the block is only part of that file — which is most of
the longer examples in the manuals. A reader who copies such a block into
a new file of that name loses everything around it.
Assisted-by: Claude Opus 5 noreply@anthropic.com
Signed-off-by: Lina Wolf