-
Notifications
You must be signed in to change notification settings - Fork 4.1k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Doc: Update getEntityRecord/s param description #42488
Merged
Merged
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
t-hamano
added
[Type] Developer Documentation
Documentation for developers
[Package] Core data
/packages/core-data
Developer Experience
Ideas about improving block and theme developer experience
labels
Jul 18, 2022
t-hamano
requested review from
nerrad,
ajitbohra,
ryanwelcher,
juanmaguitar and
fabiankaegy
as code owners
July 18, 2022 06:01
Size Change: 0 B Total Size: 1.26 MB ℹ️ View Unchanged
|
gziolo
approved these changes
Jul 19, 2022
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thank you for adding this clarification 👍🏻
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Labels
Developer Experience
Ideas about improving block and theme developer experience
[Package] Core data
/packages/core-data
[Type] Developer Documentation
Documentation for developers
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.
Fixes #31692
What?
This PR enhances the parameter descriptions for the
getEntityRecord/s
documentation.Why?
We must always include the ID when using a fields query for
getEntityRecord/s
.But as this comment states, it is not explicitly stated in the documentation and can only be read from the comments in the source code.
Testing Instructions
There are no testable code changes.