Skip to content

Commit 91d825a

Browse files
committed
Updating the phpDoc class and file descriptions.
1 parent 96d9107 commit 91d825a

File tree

1 file changed

+8
-4
lines changed

1 file changed

+8
-4
lines changed

src/Notes/AccountFailure.php

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,8 @@
11
<?php
22
/**
3-
* WooCommerce Admin: Add First Product.
4-
*
5-
* Adds a note (type `email`) to bring the client back to the store setup flow.
3+
* Adds an error note to display Pinterest API account status failure responses.
64
*
5+
* @since x.x.x
76
* @package Automattic\WooCommerce\Pinterest\Notes
87
*/
98

@@ -17,7 +16,9 @@
1716
use Automattic\WooCommerce\Admin\Notes\NoteTraits;
1817

1918
/**
20-
* Add_First_Product.
19+
* Account Failure admin notice.
20+
*
21+
* @since x.x.x
2122
*/
2223
class AccountFailure {
2324
/**
@@ -33,6 +34,7 @@ class AccountFailure {
3334
/**
3435
* Get the note.
3536
*
37+
* @since x.x.x
3638
* @param string $message Pinterest API error message.
3739
* @return Note
3840
*/
@@ -54,6 +56,7 @@ public static function get_note( string $message ) {
5456
/**
5557
* Used to add an account failure note if the one does not exist.
5658
*
59+
* @since x.x.x
5760
* @param string $message Pinterest API error message.
5861
* @return void
5962
* @throws NotesUnavailableException An exception when notes are unavailable.
@@ -70,6 +73,7 @@ public static function maybe_add_note( string $message ): void {
7073
/**
7174
* Delete the note.
7275
*
76+
* @since x.x.x
7377
* @return void
7478
*/
7579
public static function delete_note() {

0 commit comments

Comments
 (0)