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: Adds the JSDoc comment for archives block. #68508

Open
wants to merge 8 commits into
base: trunk
Choose a base branch
from

Conversation

vipul0425
Copy link
Contributor

What?

  • This PR adds the JSDoc comment for archives block.
  • It also modifies the script to read the edit.js file's doc comment and generates the attributes description.

Why?

Part of #64057

Testing Instructions

To test the script

  1. Adds the JSDoc comment for any block in the format used in archives block as part of this PR.
  2. Run the script npm run docs:blocks.
  3. Check the file changes, core-blocks.md should be updated with the attribute description you added in JSDoc comment for respective block.

Copy link

github-actions bot commented Jan 6, 2025

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: vipul0425 <[email protected]>
Co-authored-by: shail-mehta <[email protected]>

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

@shail-mehta
Copy link
Member

@vipul0425 Thanks for the PR. 👍

There is a conflict in this PR. Could you please rebase this PR?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
[Feature] Extensibility The ability to extend blocks or the editing experience [Type] Developer Documentation Documentation for developers
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants