Skip to content
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

Docs/iAPI: Fix wrong code snippets in API reference #64416

Merged

Conversation

atachibana
Copy link
Contributor

What?

The snippets in the API reference contain some errors:

wp-context sample

  • missing quotes

wp-init sample

  • Since getElement() appears for the first time on this page, it should be mentioned that this function needs to be imported.
  • </> should be </p>

Derived state sample

  • Last comma should be semi colon.

getElement sample

  • invalid comment and output json

withScope sample

  • missing bracket

wp_interactivity_process_directives

  • wrong namespace

Some minor typos were also fixed.

Why?

How?

Testing Instructions

Testing Instructions for Keyboard

Screenshots or screencast

Copy link

github-actions bot commented Aug 10, 2024

The following accounts have interacted with this PR and/or linked issues. I will continue to update these lists as activity occurs. You can also manually ask me to refresh this list by adding the props-bot label.

If you're merging code through a pull request on GitHub, copy and paste the following into the bottom of the merge commit message.

Co-authored-by: atachibana <atachibana@git.wordpress.org>
Co-authored-by: shail-mehta <shailu25@git.wordpress.org>

To understand the WordPress project's expectations around crediting contributors, please review the Contributor Attribution page in the Core Handbook.

@shail-mehta shail-mehta added the [Type] Developer Documentation Documentation for developers label Aug 10, 2024
Copy link
Member

@shail-mehta shail-mehta left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM 👍

@atachibana
Copy link
Contributor Author

@shail-mehta
Thank you. Can I ask this merge?

@shail-mehta
Copy link
Member

shail-mehta commented Aug 31, 2024

@atachibana

Could you please rebase the branch with the trunk so I can merge it? (</p> tag closing issue was fixed in last week. I apologize, I didn't notice this PR at that time.)

@atachibana
Copy link
Contributor Author

@shail-mehta
I have updated it. I hope this can be merged correctly.

@shail-mehta
Copy link
Member

Thanks for the Update @atachibana.

@shail-mehta shail-mehta merged commit 2157b85 into WordPress:trunk Sep 1, 2024
58 checks passed
@github-actions github-actions bot added this to the Gutenberg 19.2 milestone Sep 1, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
[Type] Developer Documentation Documentation for developers
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants