docs: document non-obvious embed behavior in custom_embed_blocks - #2761
Open
beeswaxpat wants to merge 1 commit into
Open
docs: document non-obvious embed behavior in custom_embed_blocks#2761beeswaxpat wants to merge 1 commit into
beeswaxpat wants to merge 1 commit into
Conversation
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
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.
Description
Adds a "Behavior that is easy to miss" section to
doc/custom_embed_blocks.mdcovering four things the API does not make obvious, each verified against master:EmbedContext.nodeis detached for custom embeds (text_line.dartre-creates the node viaCustomBlockEmbed.fromJsonString), sonode.documentOffsetis unusable there, while plain embeds such as images keep the attached node. Documents the correct ways to locate the embed.EmbedBuilder.expandedcontrols block vs inline rendering;expanded => falseroutes a single-embed line through the inlineWidgetSpanpath so text can share the line.styleattribute (ResolveImageFormatRuleaccepts only that key);WidthAttribute/HeightAttributethrowFormatExceptioninformatText, and a try/catch turns that into a silent no-op.replaceTextcommit triggers.Docs only, no code changes.
Related Issues
None.
Type of Change
🤖 Generated with Claude Code