-
Notifications
You must be signed in to change notification settings - Fork 3.1k
Twenty Eleven: Improve PHP DocBlock compliance with documentation standards #10482
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
base: trunk
Are you sure you want to change the base?
Twenty Eleven: Improve PHP DocBlock compliance with documentation standards #10482
Conversation
…ndards Updates PHP DocBlocks in Twenty Eleven theme to better align with WordPress PHP Documentation Standards. Changes include: - Use third-person singular verbs in function summaries - Add missing @return tags for better type documentation - Complete @param documentation for widget methods - Ensure proper sentence structure with punctuation - Add missing DocBlock for twentyeleven_theme_options_help()
|
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. |
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. |
dhruvang21
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
juanfra
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
There was a problem hiding this 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!
Please
- Change the
@sinceversion number fortwentyeleven_theme_options_help()(added in r19237). - Add a
@sincenote fortwentyeleven_option_page_capability(). r17987 created the function, and WordPress 3.2 bundled Twenty Eleven 1.1.
* @since Twenty Eleven 1.1
My suggestions for Twenty_Eleven_Ephemera_Widget::update() are more questionable.
Co-authored-by: Stephen A. Bernhardt <[email protected]>
Added documentation for twentyeleven_option_page_capability function.
|
Thanks for the detailed review and version history notes @sabernhardt I’ve updated the @SInCE tags accordingly and reviewed your suggestions for Twenty_Eleven_Ephemera_Widget::update(). Really appreciate your guidance! |
sabernhardt
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks!
Updates PHP DocBlocks in Twenty Eleven theme to better align with WordPress PHP Documentation Standards.
Changes include:
Files modified:
Fixes https://core.trac.wordpress.org/ticket/64211