Skip to content

Doc: Add JSDoc and update README for BlockCard component#68114

Merged
t-hamano merged 5 commits intoWordPress:trunkfrom
Infinite-Null:add/js-doc-and-readme-for-block-card
Dec 25, 2024
Merged

Doc: Add JSDoc and update README for BlockCard component#68114
t-hamano merged 5 commits intoWordPress:trunkfrom
Infinite-Null:add/js-doc-and-readme-for-block-card

Conversation

@Infinite-Null
Copy link
Contributor

@Infinite-Null Infinite-Null commented Dec 19, 2024 •
edited
Loading

Part of: #67165
Follow up of: #67191

What?

  • Add JSDoc documentation to the BlockCard component.
  • Update README.md to document the name prop, which was previously missing.

@github-actions
Copy link

github-actions bot commented Dec 19, 2024 •
edited
Loading

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: Infinite-Null <ankitkumarshah@git.wordpress.org>
Co-authored-by: t-hamano <wildworks@git.wordpress.org>

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

@Infinite-Null
Copy link
Contributor Author

Infinite-Null commented Dec 19, 2024

Hi @t-hamano,
This is a follow-up PR for #67191 addressing the feedback in this comment. It adds JSDoc and includes the name prop in the README.md. Please have a look at it at your convenience.

@t-hamano t-hamano mentioned this pull request Dec 19, 2024
Open
t-hamano
t-hamano reviewed Dec 23, 2024
View reviewed changes
Copy link
Contributor

@t-hamano t-hamano left a comment

Choose a reason for hiding this comment

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

Thanks for the PR!

@t-hamano t-hamano added Storybook Storybook and its stories for components [Type] Developer Documentation Documentation for developers labels Dec 23, 2024
@Infinite-Null
Copy link
Contributor Author

Infinite-Null commented Dec 24, 2024

Hi @t-hamano,

I’ve implemented the suggested changes and resolved the merge conflict. When you have a moment, could you please review it. Thank you!

t-hamano
t-hamano approved these changes Dec 25, 2024
View reviewed changes
Copy link
Contributor

@t-hamano t-hamano left a comment

Choose a reason for hiding this comment

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

LGTM 👍

@t-hamano t-hamano merged commit ead6fac into WordPress:trunk Dec 25, 2024
@github-actions github-actions bot added this to the Gutenberg 20.0 milestone Dec 25, 2024
Gulamdastgir-Momin pushed a commit to Gulamdastgir-Momin/gutenberg that referenced this pull request Jan 23, 2025
@Infinite-Null @t-hamano @Gulamdastgir-Momin
Doc: Add JSDoc and update README for BlockCard component (WordPress#6…
dc96cff 
…8114)

* Add JSDoc and update README for BlockCard component

* Docs: Improve BlockCard component JSDoc documentation

* docs: Improve BlockCard component JSDoc documentation

* Docs: Improve indentation of BlockCard component JSDoc documentation

Co-authored-by: Infinite-Null <ankitkumarshah@git.wordpress.org>
Co-authored-by: t-hamano <wildworks@git.wordpress.org>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@t-hamano t-hamano t-hamano approved these changes

@ellatrix ellatrix Awaiting requested review from ellatrix ellatrix is a code owner

Assignees

No one assigned

Labels

Storybook Storybook and its stories for components [Type] Developer Documentation Documentation for developers

Projects

None yet

Milestone

Gutenberg 20.0

Development

Successfully merging this pull request may close these issues.

2 participants

@Infinite-Null @t-hamano