-
Notifications
You must be signed in to change notification settings - Fork 4.3k
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
[Documentation] Add @example for getNotices to create example in the handbook. #42023
Merged
ryanwelcher
merged 20 commits into
WordPress:trunk
from
ryanwelcher:feature/add-examples-to-notices-docs
Jun 30, 2022
Merged
[Documentation] Add @example for getNotices to create example in the handbook. #42023
ryanwelcher
merged 20 commits into
WordPress:trunk
from
ryanwelcher:feature/add-examples-to-notices-docs
Jun 30, 2022
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
…ow what packages are being installed.
ryanwelcher
requested review from
ajitbohra,
gziolo,
juanmaguitar and
fabiankaegy
as code owners
June 28, 2022 18:57
ryanwelcher
added
[Package] Notices
/packages/notices
Developer Experience
Ideas about improving block and theme developer experience
[Type] Developer Documentation
Documentation for developers
labels
Jun 28, 2022
ryanwelcher
changed the title
Feature/add examples to notices docs
Docs: Add @example for getNotices
Jun 28, 2022
ryanwelcher
changed the title
Docs: Add @example for getNotices
[Documentation] Add @example for getNotices to create example in the handbook.
Jun 28, 2022
mburridge
approved these changes
Jun 30, 2022
19 tasks
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] Notices
/packages/notices
[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.
What?
Adds an
@examples
entry for thegetNotices
selector to provide an example in the handbook.Why?
There are very few code examples in the Data Modules section of the developer handbook. Adding some would be very helpful. Tracking issue: WordPress/Documentation-Issue-Tracker#379
How?
Adding
@example
tags to each docblock.