Docs: Add JSDoc to privacy tools JavaScript#12058
Conversation
|
Hi @yusufhay! 👋 Thank you for your contribution to WordPress! 💖 It looks like this is your first pull request to No one monitors this repository for new pull requests. Pull requests must be attached to a Trac ticket to be considered for inclusion in WordPress Core. To attach a pull request to a Trac ticket, please include the ticket's full URL in your pull request description. Pull requests are never merged on GitHub. The WordPress codebase continues to be managed through the SVN repository that this GitHub repository mirrors. Please feel free to open pull requests to work on any contribution you are making. More information about how GitHub pull requests can be used to contribute to WordPress can be found in the Core Handbook. Please include automated tests. Including tests in your pull request is one way to help your patch be considered faster. To learn about WordPress' test suites, visit the Automated Testing page in the handbook. If you have not had a chance, please review the Contribute with Code page in the WordPress Core Handbook. The Developer Hub also documents the various coding standards that are followed:
Thank you, |
|
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 Core Committers: Use this line as a base for the props when committing in SVN: To understand the WordPress project's expectations around crediting contributors, please review the Contributor Attribution page in the Core Handbook. |
|
Thanks for the guidance! This PR is linked to the Trac ticket in the description: https://core.trac.wordpress.org/ticket/49381 This is a documentation-only JavaScript change, so I did not add automated tests. I ran the following checks locally: node --check src/js/_enqueues/admin/privacy-tools.js
git diff --check -- src/js/_enqueues/admin/privacy-tools.js |
Test using WordPress PlaygroundThe changes in this pull request can previewed and tested using a WordPress Playground instance. WordPress Playground is an experimental project that creates a full WordPress instance entirely within the browser. Some things to be aware of
For more details about these limitations and more, check out the Limitations page in the WordPress Playground documentation. |
Trac ticket: https://core.trac.wordpress.org/ticket/49381
This refreshes the JavaScript documentation work for
privacy-tools.jswith focused JSDoc blocks for the internal privacy request helper functions.The documented functions cover action state handling, result notice rendering, export progress, and erasure progress.
Testing:
node --check src/js/_enqueues/admin/privacy-tools.jsgit diff --check -- src/js/_enqueues/admin/privacy-tools.jsNotes: