Skip to content

Commit da32bc5

Browse files
committed
Docs: various small formating fixes
Align parameter descriptions in docblocks and other minor formatting fixes. Note: there is one more to fix, but this is waiting on a [bug fix in PHPCS](squizlabs/PHP_CodeSniffer#3893) (bug discovered when making this change).
1 parent b7af68e commit da32bc5

File tree

3 files changed

+9
-4
lines changed

3 files changed

+9
-4
lines changed

src/Whip_Host.php

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,7 @@ public static function name() {
4040
* In a non-WordPress content this function just returns the passed name.
4141
*
4242
* @param string $name The current name of the host.
43+
*
4344
* @return string The filtered name of the host.
4445
*/
4546
private static function filterName( $name ) {
@@ -96,6 +97,7 @@ public static function hostingPageUrl() {
9697
* In a non-WordPress context this function just returns a link to the Yoast hosting page.
9798
*
9899
* @param string $url The previous URL.
100+
*
99101
* @return string The new URL to the hosting overview page.
100102
*/
101103
private static function filterHostingPageUrl( $url ) {

src/Whip_MessageFormatter.php

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,7 @@ final class Whip_MessageFormatter {
1414
* Wraps a piece of text in HTML strong tags.
1515
*
1616
* @param string $toWrap The text to wrap.
17+
*
1718
* @return string The wrapped text.
1819
*/
1920
public static function strong( $toWrap ) {
@@ -24,6 +25,7 @@ public static function strong( $toWrap ) {
2425
* Wraps a piece of text in HTML p tags.
2526
*
2627
* @param string $toWrap The text to wrap.
28+
*
2729
* @return string The wrapped text.
2830
*/
2931
public static function paragraph( $toWrap ) {
@@ -34,6 +36,7 @@ public static function paragraph( $toWrap ) {
3436
* Wraps a piece of text in HTML p and strong tags.
3537
*
3638
* @param string $toWrap The text to wrap.
39+
*
3740
* @return string The wrapped text.
3841
*/
3942
public static function strongParagraph( $toWrap ) {

tests/WPMessageDismissListenerTest.php

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -19,11 +19,11 @@ class WPMessageDismissListener extends Whip_TestCase {
1919
*
2020
* @dataProvider listenProvider
2121
*
22-
* @param string $action The action to test.
23-
* @param string $nonce The nonce to test.
22+
* @param string $action The action to test.
23+
* @param string $nonce The nonce to test.
2424
* @param int $verifyNonceTimes The times to call wp_verify_nonce.
25-
* @param bool $isCorrectNonce Whether the nonce is correct.
26-
* @param bool $dismissTimes The times to call dismiss.
25+
* @param bool $isCorrectNonce Whether the nonce is correct.
26+
* @param bool $dismissTimes The times to call dismiss.
2727
*/
2828
public function testDismiss( $action, $nonce, $verifyNonceTimes, $isCorrectNonce, $dismissTimes ) {
2929
$dismisser = $this->getMockBuilder( 'Whip_MessageDismisser' )

0 commit comments

Comments
 (0)