Docs: Undo/Redo: Minor edits #51085
Merged
Docs: Undo/Redo: Minor edits #51085
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
mcsf
requested review from
ajitbohra,
ryanwelcher,
juanmaguitar,
fabiankaegy and
ndiego
as code owners
mcsf
commented
May 30, 2023
| @@ -42,13 +42,13 @@ Since the WordPress editors allow multiple entity records to be edited at the sa | |||
|
|
|||
| And to be able to perform both undo and redo operations propertly, each modification in the list of edits contains the following information: | |||
|
|
|||
| - Entity kind and name: Each entity in core-data is identified by a tuple kind, name. This corresponds to the identifier of the modified entity. | |||
| - Entity kind and name: Each entity in core-data is identified by the pair _(kind, name)_. This corresponds to the identifier of the modified entity. | |||
There was a problem hiding this comment.
I chose "pair" to reduce confusion for developers on whether they should actually pass a tuple [ 123, 456 ] to our API's functions, when actually the pair is always flattened into the rest of the arguments.
mcsf
commented
May 30, 2023
| @@ -24,7 +24,7 @@ Once the entity is loaded, you can edit it. For example, the following code sets | |||
|
|
|||
| The package also exposes a set of actions to manipulate the fetched entity records. | |||
|
|
|||
| To fetch an entity record, you can call `editEntityRecord`, which takes the entity type, the entity ID and the new entity record as parameters. The following example sets the title of the post with ID 1 to "Hello World". | |||
| To edit an entity record, you can call `editEntityRecord`, which takes the entity type, the entity ID and the new entity record as parameters. The following example sets the title of the post with ID 1 to "Hello World". | |||
There was a problem hiding this comment.
This is what prompted me to open the PR; everything else is just nitpicking.
youknowriad
approved these changes
May 30, 2023
|
Makes sense. |
|
Flaky tests detected in 5efbc04. 🔍 Workflow run URL: https://github.com/WordPress/gutenberg/actions/runs/5119837181
|
sethrubenstein
pushed a commit
to pewresearch/gutenberg
that referenced
this pull request
Jul 13, 2023
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.
Small follow-up of #51052.