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

Recommendation: PHP documentation standards #65

Open
justintadlock opened this issue Feb 1, 2018 · 2 comments
Open

Recommendation: PHP documentation standards #65

justintadlock opened this issue Feb 1, 2018 · 2 comments

Comments

@justintadlock
Copy link

justintadlock commented Feb 1, 2018

You've got quite a bit of inline docs. I'd love to see these cleaned up and in line with the WP PHP documentation standards found here: https://make.wordpress.org/core/handbook/best-practices/inline-documentation-standards/php/

Even just having the @since in PHPDoc blocks makes a world of difference 6 months, 1 year, or longer down the road in development.

I just want to encourage spending a little more time on this as you develop the theme.

@ideadude
Copy link
Member

ideadude commented Mar 7, 2018

Woah. I just realized I can update other folks comments here. I changed @version to @since in your comment, which is what I think you meant.

We will review the doc blocks and set a @since tag to the best of our abilities.

@justintadlock
Copy link
Author

Yep, I meant @since.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants