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

add: usage examples in core editor docs #63768

Merged

Conversation

troychaplin
Copy link
Contributor

What?

Usage examples in documentation for core/editor package for editPost, getEditedPostAttribute and getCurrentPostType. Part of #42125

Why?

Because examples are important and help devs learn to use the tools

How?

The noted selectors / actions had no examples prior to this PR

Copy link

Warning: Type of PR label mismatch

To merge this PR, it requires exactly 1 label indicating the type of PR. Other labels are optional and not being checked here.

  • Type-related labels to choose from: [Type] Automated Testing, [Type] Breaking Change, [Type] Bug, [Type] Build Tooling, [Type] Code Quality, [Type] Copy, [Type] Developer Documentation, [Type] Enhancement, [Type] Experimental, [Type] Feature, [Type] New API, [Type] Task, [Type] Technical Prototype, [Type] Performance, [Type] Project Management, [Type] Regression, [Type] Security, [Type] WP Core Ticket, Backport from WordPress Core.
  • Labels found: .

Read more about Type labels in Gutenberg. Don't worry if you don't have the required permissions to add labels; the PR reviewer should be able to help with the task.

Copy link

github-actions bot commented Jul 20, 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: troychaplin <areziaal@git.wordpress.org>
Co-authored-by: ryanwelcher <welcher@git.wordpress.org>

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

@troychaplin troychaplin changed the title add: usage examples in core editor docs for editPost, getEditedPostAttribute, getCurrentPostType add: usage examples in core editor docs Jul 20, 2024
@t-hamano t-hamano added the [Type] Developer Documentation Documentation for developers label Jul 20, 2024
Copy link
Contributor

@ryanwelcher ryanwelcher left a comment

Choose a reason for hiding this comment

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

Try running npm run lint:js:fix to see if that updates the examples to match the standards.

Get the current post type

```js
const currentPostType = wp.data.select('core/editor').getCurrentPostType()
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
const currentPostType = wp.data.select('core/editor').getCurrentPostType()
const currentPostType = wp.data.select( 'core/editor' ).getCurrentPostType()

Copy link
Contributor

Choose a reason for hiding this comment

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

Looks like the whitespace is different than WP coding standards and that's what is failing .

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I got my formatting conflict fix up in vscode, and it appears to be using WP standards (it's been a min, been uring psr for a long time) but it's still failing. If I try and run npm run lint:js:fix I get a warning that stops the process, which also happens to me when I update trunk. This might be a new issue? I'll have to check the issues

Screenshot 2024-07-25 at 8 45 02 PM

@ryanwelcher
Copy link
Contributor

I just took a quick look and there seems to be a lot of whitespace changes that don't look like they should be there.

@troychaplin
Copy link
Contributor Author

I just took a quick look and there seems to be a lot of whitespace changes that don't look like they should be there.

A bit confused on this one. I can't run npm run lint:js:fix due to a conflict with@typescript-eslint/typescript-estree. I downgraded typescript to version 5.1.6, which allows the lint fix to run, and while there's a lot of warnings, nothing shows as being changed other than my expected package files.

Screenshot 2024-08-02 at 11 02 18 AM

Copy link
Contributor

@ryanwelcher ryanwelcher left a comment

Choose a reason for hiding this comment

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

LGTM! :shipit:

@ryanwelcher ryanwelcher merged commit 3e37c60 into WordPress:trunk Oct 4, 2024
62 checks passed
@github-actions github-actions bot added this to the Gutenberg 19.5 milestone Oct 4, 2024
@flexseth
Copy link
Contributor

flexseth commented Oct 5, 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.

4 participants