Commit Graph

21 Commits

Author SHA1 Message Date
Gary Pendergast
a75d153eee Coding Standards: Upgrade WPCS to 1.0.0
WPCS 1.0.0 includes a bunch of new auto-fixers, which drops the number of coding standards issues across WordPress significantly. Prior to running the auto-fixers, there were 15,312 issues detected. With this commit, we now drop to 4,769 issues.

This change includes three notable additions:
- Multiline function calls must now put each parameter on a new line.
- Auto-formatting files is now part of the `grunt precommit` script. 
- Auto-fixable coding standards issues will now cause Travis failures.

Fixes #44600.



git-svn-id: https://develop.svn.wordpress.org/trunk@43571 602fd350-edb4-49c9-b593-d223f7449a82
2018-08-17 01:50:26 +00:00
Gary Pendergast
8f95800d52 Code is Poetry.
WordPress' code just... wasn't.
This is now dealt with.

Props jrf, pento, netweb, GaryJ, jdgrimes, westonruter, Greg Sherwood from PHPCS, and everyone who's ever contributed to WPCS and PHPCS.
Fixes #41057.



git-svn-id: https://develop.svn.wordpress.org/trunk@42343 602fd350-edb4-49c9-b593-d223f7449a82
2017-11-30 23:09:33 +00:00
John Blackbourn
19c0a55711 Docs: Standardise the format used for documenting parameters passed by reference.
See #35974, #41017


git-svn-id: https://develop.svn.wordpress.org/trunk@41688 602fd350-edb4-49c9-b593-d223f7449a82
2017-10-02 22:13:04 +00:00
Drew Jaynes
b4d81bd654 Docs: Remove @access notations from method DocBlocks in wp-includes/* classes.
Prior to about 2013, many class methods lacked even access modifiers which made the `@access` notations that much more useful. Now that we've gotten to a point where the codebase is more mature from a maintenance perspective and we can finally remove these notations. Notable exceptions to this change include standalone functions notated as private as well as some classes still considered to represent "private" APIs.

See #41452.


git-svn-id: https://develop.svn.wordpress.org/trunk@41162 602fd350-edb4-49c9-b593-d223f7449a82
2017-07-27 00:40:27 +00:00
Sergey Biryukov
75c975c5d1 I18N: Add translator comments for strings in wp-includes/class-walker-comment.php.
Merge two similar strings.

Props ramiy.
Fixes #37796.

git-svn-id: https://develop.svn.wordpress.org/trunk@38342 602fd350-edb4-49c9-b593-d223f7449a82
2016-08-23 23:32:15 +00:00
Scott Taylor
6dcd17ff9c Comments: pass $comment to comment_text() in Walker_Comment::comment() instead of using a function which can skip the cache.
Props rachelbaker.
Fixes #35433.


git-svn-id: https://develop.svn.wordpress.org/trunk@37325 602fd350-edb4-49c9-b593-d223f7449a82
2016-04-29 15:46:39 +00:00
Drew Jaynes
39bdd5fc3d Docs: Normalize Walker_Comment method parameter docs spacing following [37051].
See #36300.


git-svn-id: https://develop.svn.wordpress.org/trunk@37052 602fd350-edb4-49c9-b593-d223f7449a82
2016-03-22 17:45:26 +00:00
Drew Jaynes
542f0a118e Docs: Comment display element object types for Walker_Comment are WP_Comment since 4.4.0.
See #36300.


git-svn-id: https://develop.svn.wordpress.org/trunk@37051 602fd350-edb4-49c9-b593-d223f7449a82
2016-03-22 17:43:51 +00:00
Drew Jaynes
c4f61cf686 Docs: Improve inline documentation syntax for Walker_Comment.
* Marks optional parameters as such
* Improves existing parameter descriptions for clarity
* Syntax improvements

See #36300.


git-svn-id: https://develop.svn.wordpress.org/trunk@37050 602fd350-edb4-49c9-b593-d223f7449a82
2016-03-22 17:40:27 +00:00
Drew Jaynes
436a966430 Docs: Standardize the class DocBlock summary for Walker_Comment.
See #36300.


git-svn-id: https://develop.svn.wordpress.org/trunk@37049 602fd350-edb4-49c9-b593-d223f7449a82
2016-03-22 17:35:34 +00:00
Drew Jaynes
7479108b35 Docs: Improve inline documentation for properties and methods in Walker_Comment.
Props raimy for the initial patch.
See #36300.


git-svn-id: https://develop.svn.wordpress.org/trunk@37048 602fd350-edb4-49c9-b593-d223f7449a82
2016-03-22 17:33:56 +00:00
Drew Jaynes
0794999be8 Docs: Document the $id parameter for Walker_Comment::start_el(), which is implemented by Walker but unused in the subclass method.
See #32246.


git-svn-id: https://develop.svn.wordpress.org/trunk@35927 602fd350-edb4-49c9-b593-d223f7449a82
2015-12-14 17:49:22 +00:00
Scott Taylor
c123726ba0 Docs: some @global object vernaculars should be converted to the actual object type.
See #33491.


git-svn-id: https://develop.svn.wordpress.org/trunk@35013 602fd350-edb4-49c9-b593-d223f7449a82
2015-10-10 15:44:16 +00:00
Drew Jaynes
f26526264a Docs: Fix wrapping and syntax for a multi-comment in Walker_Comment::display_element().
See #32246.


git-svn-id: https://develop.svn.wordpress.org/trunk@34993 602fd350-edb4-49c9-b593-d223f7449a82
2015-10-09 21:02:43 +00:00
Drew Jaynes
0d444dc6f9 Docs: Indent an example comment tree in the DocBlock for Walker_Comment::display_element() so it can be properly parsed in Markdown for the Code Reference.
See #32246.


git-svn-id: https://develop.svn.wordpress.org/trunk@34992 602fd350-edb4-49c9-b593-d223f7449a82
2015-10-09 20:59:57 +00:00
Drew Jaynes
10278a11d3 Docs: The Comment API is singular.
See #33701.


git-svn-id: https://develop.svn.wordpress.org/trunk@34409 602fd350-edb4-49c9-b593-d223f7449a82
2015-09-22 13:42:15 +00:00
Scott Taylor
5cce4a3262 After [33961], pass $comment to get_comment_link() where possible to avoid extra cache/db lookups.
See #33638.


git-svn-id: https://develop.svn.wordpress.org/trunk@34042 602fd350-edb4-49c9-b593-d223f7449a82
2015-09-11 06:20:56 +00:00
Scott Taylor
4a6a7edf55 After [33961], pass $comment to get_comment_date() where possible to avoid extra cache/db lookups.
See #33638.


git-svn-id: https://develop.svn.wordpress.org/trunk@34041 602fd350-edb4-49c9-b593-d223f7449a82
2015-09-11 06:14:04 +00:00
Scott Taylor
9ab431873c After [33961], pass $comment to comment_class() where possible to avoid extra cache/db lookups.
See #33638.


git-svn-id: https://develop.svn.wordpress.org/trunk@34040 602fd350-edb4-49c9-b593-d223f7449a82
2015-09-11 06:11:35 +00:00
Scott Taylor
db702bc3ea After [33961], pass $comment to get_comment_author_link() where possible to avoid extra cache/db lookups.
See #33638.


git-svn-id: https://develop.svn.wordpress.org/trunk@34039 602fd350-edb4-49c9-b593-d223f7449a82
2015-09-11 06:04:22 +00:00
Scott Taylor
8088ffafd6 Walker_Comment should be in its own file. Loaded now via wp-includes/comment.php, which makes it 100% BC.
See #33413.


git-svn-id: https://develop.svn.wordpress.org/trunk@33962 602fd350-edb4-49c9-b593-d223f7449a82
2015-09-09 02:40:53 +00:00