Docs: include example of serialized blocks in "language" doc. #3005
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
gziolo
approved these changes
Oct 13, 2017
docs/language.md
Outdated
| @@ -81,6 +81,24 @@ This has dramatic implications for how simple and performant we can make our par | |||
|
|
|||
| _N.B.:_ The defining aspect of blocks are their semantics and the isolation mechanism they provide; in other words, their identity. On the other hand, where their data is stored is a more liberal aspect. Blocks support more than just static local data (via JSON literals inside the HTML comment or within the block's HTML), and more mechanisms (_e.g._, global blocks or otherwise resorting to storage in complementary `WP_Post` objects) are expected. See [attributes](../reference/attributes) for details. | |||
|
|
|||
| ## The Anatomy of a Serialized Block | |||
|
|
|||
| When blocks are saved to the content after the editing session, the different attributes—depending on the nature of the block—are serialized to these explicit comment delimiters. | |||
There was a problem hiding this comment.
I see we use — in a few places, why we avoid spaces around this delimiter?
aduth
reviewed
Oct 13, 2017
docs/language.md
Outdated
| @@ -81,6 +81,24 @@ This has dramatic implications for how simple and performant we can make our par | |||
|
|
|||
| _N.B.:_ The defining aspect of blocks are their semantics and the isolation mechanism they provide; in other words, their identity. On the other hand, where their data is stored is a more liberal aspect. Blocks support more than just static local data (via JSON literals inside the HTML comment or within the block's HTML), and more mechanisms (_e.g._, global blocks or otherwise resorting to storage in complementary `WP_Post` objects) are expected. See [attributes](../reference/attributes) for details. | |||
|
|
|||
| ## The Anatomy of a Serialized Block | |||
|
|
|||
| When blocks are saved to the content after the editing session, the different attributes—depending on the nature of the block—are serialized to these explicit comment delimiters. | |||
There was a problem hiding this comment.
The word "different" feels out of place here. Should we drop it, or be more specific about those attributes which are serialized in the delimiters?
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.
Adding a small section towards the end showing how blocks might be saved.