Documentation: Fix @todo tags to follow standards in WordPress comments. #60148
Conversation
interdevel
requested review from
dmsnell,
tellthemachines,
spacedmonkey,
ajitbohra,
ntwb,
nerrad,
ellatrix,
artemiomorales,
michalczaplinski and
geriux
as code owners
|
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 If you're merging code through a pull request on GitHub, copy and paste the following into the bottom of the merge commit message. To understand the WordPress project's expectations around crediting contributors, please review the Contributor Attribution page in the Core Handbook. |
github-actions
bot
added
the
First-time Contributor
|
👋 Thanks for your first Pull Request and for helping build the future of Gutenberg and WordPress, @interdevel! In case you missed it, we'd love to have you join us in our Slack community. If you want to learn more about WordPress development in general, check out the Core Handbook full of helpful information. |
cbravobernal
added
the
[Type] Developer Documentation
cbravobernal
changed the title
| @@ -508,7 +508,7 @@ public function step( $node_to_process = self::PROCESS_NEXT_NODE ) { | |||
| * When moving on to the next node, therefore, if the bottom-most element | |||
| * on the stack is a void element, it must be closed. | |||
| * | |||
| * @TODO: Once self-closing foreign elements and BGSOUND are supported, | |||
| * @todo Once self-closing foreign elements and BGSOUND are supported, | |||
There was a problem hiding this comment.
we should not be changing code inside the compat/*/html-api directory, since these files are maintained in Core and backported into Gutenberg. there's an exclusion rule in the linting to ignore this directory.
if someone wants to change the code style, it needs to happen in Core and be brought back. since this code is historic for the 6.4 release it should not be changed at all. thankfully it will be removed shortly so this doesn't matter, but please take note so that we don't create divergence between the repositories.
There was a problem hiding this comment.
Didn't know about this detail, thanks for commenting!
Co-authored-by: interdevel <interdevel@git.wordpress.org> Co-authored-by: huzaifaalmesbah <huzaifaalmesbah@git.wordpress.org>
|
Looks like these were already fixed in core (e.g. https://github.com/WordPress/wordpress-develop/blob/6974b994de5e9c707607dcb4233bd785865b4c6a/src/wp-includes/html-api/class-wp-html-processor.php#L248) so no need to back port https://github.com/search?q=repo%3AWordPress%2Fwordpress-develop+%2F%28%3F-i%29%40TODO%2F&type=code |
What?
Ensure proper case for "@todo" tags in phpdocs.
Fixes #59539
Why?
There was invalid @todo tags (invalid: @todo: @todo @todo:)
How?
I've changed the @todo tags found in files to follow guidelines in https://developer.wordpress.org/coding-standards/inline-documentation-standards/php/#phpdoc-tags
PR done in WordCamp Torrelodones 2024 Core contributor table.