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

Documentation: PostSwitchToDraftButton editor component #62381

Merged

Conversation

colorful-tones
Copy link
Member

What? & Why?

Addresses one item in #60358

Adding documentation to existing editor components can help with any of the following:

  • encourages knowledge sharing and quicker onboarding for future devs
  • supports maintenance and troubleshooting
  • mitigates risk

How?

Add a JSDoc comment to the PostSwitchToDraftButton component and run npm run docs:build to populate the README with the newly added documents.

@colorful-tones colorful-tones added the [Type] Developer Documentation Documentation for developers label Jun 6, 2024
@colorful-tones
Copy link
Member Author

@ntsekouras this particular one was marked with // TODO: deprecate... So, it is likely this PR should not be merged. Please verify and I'll close. Thanks!

Copy link

github-actions bot commented Jun 6, 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: colorful-tones <colorful-tones@git.wordpress.org>

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

Copy link
Contributor

@ntsekouras ntsekouras left a comment

Choose a reason for hiding this comment

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

It doesn't hurt to add the docs even if it's quite late 😄 . Let's merge and will open a quick PR for deprecating this. Thank you!

@ntsekouras ntsekouras merged commit b79f12f into WordPress:trunk Jun 7, 2024
64 of 65 checks passed
@github-actions github-actions bot added this to the Gutenberg 18.6 milestone Jun 7, 2024
patil-vipul pushed a commit to patil-vipul/gutenberg that referenced this pull request Jun 17, 2024
)

* Add JSDoc block for PostSwitchToDraftButton component

* Auto-generate editor docs for PostSwitchToDraftButton
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
2 participants