Conversation
jrfnl
commented
Jan 7, 2016
jrfnl
commented
- Stay in line with core: page titles now use H1, not H2.
- Fix incorrect concatenation for translated strings.
- Improved variable names and remove superfluous condition - see Variable admin notices based on user level. #507.
- Use local variable instead of global where available.
- Re-sync the bulk_install() method with the core bulk_upgrade() method.
- Correct and clarify the documentation for the example function.
- Fix two wrong text domain slugs in the example file.
class-tgm-plugin-activation.php
Outdated
There was a problem hiding this comment.
Move non-tagged content above the PHPDoc tags.
There was a problem hiding this comment.
Added the @internal tag now as the comment does not make sense if moved up.
There was a problem hiding this comment.
For an internal note, it should use the inline format. See https://github.com/phpDocumentor/fig-standards/blob/master/proposed/phpdoc.md#78-internal . Note the double-closing }.
There was a problem hiding this comment.
I'll adjust. All the same: the {} annotation is a quite recent change and hasn't been in use that long. Secondly the PSR is still in concept phase, so subject to change and as the annotation is a change, it may well change back to how it always used to be used, i.e. without the {}.
There was a problem hiding this comment.
Adjusted all other occurrences of @internal as well.
There was a problem hiding this comment.
phpDocumentor, naturally (same developer), already follows the same format: http://www.phpdoc.org/docs/latest/references/phpdoc/tags/internal.html.
https://github.com/WordPress/WordPress/blob/master/wp-includes/shortcodes.php#L17-L20 is one instance of the format in WP core, though they are other formats too that have not have been fixed up yet.
jrfnl
force-pushed
the
feature/various-minor-fixes
branch
from
ed668be to
b7c5023
Compare
* Stay in line with core: page titles now use H1, not H2. * Fix incorrect concatenation for translated strings. * Improved variable names and remove superfluous condition - see #507. * Use local variable instead of global where available. * Re-sync the bulk_install() method with the core bulk_upgrade() method. * Use {..}} annotation for all comments tagged with @internal. * Correct and clarify the documentation for the example function. * Fix two wrong text domain slugs in the example file.
jrfnl
force-pushed
the
feature/various-minor-fixes
branch
from
b7c5023 to
88da3fb
Compare
2 participants
