Skip to content

Commit

Permalink
Docs: various small formating fixes
Browse files Browse the repository at this point in the history
Align parameter descriptions in docblocks and other minor formatting fixes.
  • Loading branch information
jrfnl committed Sep 26, 2023
1 parent b7af68e commit 8197fe3
Show file tree
Hide file tree
Showing 4 changed files with 10 additions and 4 deletions.
2 changes: 2 additions & 0 deletions src/Whip_Host.php
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,7 @@ public static function name() {
* In a non-WordPress content this function just returns the passed name.
*
* @param string $name The current name of the host.
*
* @return string The filtered name of the host.
*/
private static function filterName( $name ) {
Expand Down Expand Up @@ -96,6 +97,7 @@ public static function hostingPageUrl() {
* In a non-WordPress context this function just returns a link to the Yoast hosting page.
*
* @param string $url The previous URL.
*
* @return string The new URL to the hosting overview page.
*/
private static function filterHostingPageUrl( $url ) {
Expand Down
3 changes: 3 additions & 0 deletions src/Whip_MessageFormatter.php
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ final class Whip_MessageFormatter {
* Wraps a piece of text in HTML strong tags.
*
* @param string $toWrap The text to wrap.
*
* @return string The wrapped text.
*/
public static function strong( $toWrap ) {
Expand All @@ -24,6 +25,7 @@ public static function strong( $toWrap ) {
* Wraps a piece of text in HTML p tags.
*
* @param string $toWrap The text to wrap.
*
* @return string The wrapped text.
*/
public static function paragraph( $toWrap ) {
Expand All @@ -34,6 +36,7 @@ public static function paragraph( $toWrap ) {
* Wraps a piece of text in HTML p and strong tags.
*
* @param string $toWrap The text to wrap.
*
* @return string The wrapped text.
*/
public static function strongParagraph( $toWrap ) {
Expand Down
1 change: 1 addition & 0 deletions src/presenters/Whip_WPMessagePresenter.php
Original file line number Diff line number Diff line change
Expand Up @@ -58,6 +58,7 @@ public function registerHooks() {
*
* @deprecated 1.2.0 Use the Whip_WPMessagePresenter::registerHooks() method instead.
* @codeCoverageIgnore
*
* @phpcs:disable Generic.NamingConventions.CamelCapsFunctionName
*/
public function register_hooks() {
Expand Down
8 changes: 4 additions & 4 deletions tests/WPMessageDismissListenerTest.php
Original file line number Diff line number Diff line change
Expand Up @@ -19,11 +19,11 @@ class WPMessageDismissListener extends Whip_TestCase {
*
* @dataProvider listenProvider
*
* @param string $action The action to test.
* @param string $nonce The nonce to test.
* @param string $action The action to test.
* @param string $nonce The nonce to test.
* @param int $verifyNonceTimes The times to call wp_verify_nonce.
* @param bool $isCorrectNonce Whether the nonce is correct.
* @param bool $dismissTimes The times to call dismiss.
* @param bool $isCorrectNonce Whether the nonce is correct.
* @param bool $dismissTimes The times to call dismiss.
*/
public function testDismiss( $action, $nonce, $verifyNonceTimes, $isCorrectNonce, $dismissTimes ) {
$dismisser = $this->getMockBuilder( 'Whip_MessageDismisser' )
Expand Down

0 comments on commit 8197fe3

Please sign in to comment.