Docs: improve grammar in plugin.php file header comment #10696
Conversation
Fix typo in plugin API documentation.
|
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 Unlinked AccountsThe following contributors have not linked their GitHub and WordPress.org accounts: @SAURABHHAM44. Contributors, please read how to link your accounts to ensure your work is properly credited in WordPress releases. 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. |
|
Hi @SAURABHHAM44! 👋 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, |
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. |
|
This can be committed as part of Core-64224. @SAURABHHAM44 What is your WordPress.org username? |
| * The plugin API is located in this file, which allows for creating actions | ||
| * and filters and hooking functions, and methods. The functions or methods will | ||
| * and filters and hooking functionsand methods. The functions or methods will | ||
| * then be run when the action or filter is called. |
There was a problem hiding this comment.
Suggested improvement:
* The plugin API defined here allows for callbacks (functions/methods) to be
* registered with hooks, which are either actions and filters. The callbacks are
* invoked when an action is done or a filter is applied.
| /** | ||
| * The plugin API is located in this file, which allows for creating actions | ||
| * and filters and hooking functions, and methods. The functions or methods will | ||
| * and filters and hooking functionsand methods. The functions or methods will |
There was a problem hiding this comment.
Removing the comma makes this worse.
2 participants
Description
This PR improves the grammar in the file header comment of
src/wp-includes/plugin.php.Change Made:
Removed an awkward comma from the line:
Why:
The comma placement was grammatically incorrect and made the sentence harder to read. This improves clarity for developers reading the plugin API documentation.
Testing:
Note: A corresponding Trac ticket should be created at https://core.trac.wordpress.org/ for this PR to be considered for merging. Please add the ticket number using: Fixes: #[TICKET_NUMBER]