docs: update comments

kenjis · kenjis · commit 40394467a665 · 2022-05-10T21:23:21.000+09:00
diff --git a/src/Authentication/Passwords/BaseValidator.php b/src/Authentication/Passwords/BaseValidator.php
@@ -27,7 +27,7 @@ public function error(): ?string
      * Returns a suggestion that may be displayed to the user
      * to help them choose a better password. The method is
      * required, but a suggestion is optional. May return
-     * an empty string instead.
+     * null instead.
      */
     public function suggestion(): ?string
     {
diff --git a/src/Authentication/Passwords/ValidatorInterface.php b/src/Authentication/Passwords/ValidatorInterface.php
@@ -30,7 +30,7 @@ public function error(): ?string;
      * Returns a suggestion that may be displayed to the user
      * to help them choose a better password. The method is
      * required, but a suggestion is optional. May return
-     * an empty string instead.
+     * null instead.
      */
     public function suggestion(): ?string;
 }

Original file line number	Diff line number	Diff line change
`@@ -27,7 +27,7 @@ public function error(): ?string`
`27`	`27`	`* Returns a suggestion that may be displayed to the user`
`28`	`28`	`* to help them choose a better password. The method is`
`29`	`29`	`* required, but a suggestion is optional. May return`
`30`		`- * an empty string instead.`
	`30`	`+ * null instead.`
`31`	`31`	`*/`
`32`	`32`	`public function suggestion(): ?string`
`33`	`33`	`{`
Original file line number	Diff line number	Diff line change
`@@ -30,7 +30,7 @@ public function error(): ?string;`
`30`	`30`	`* Returns a suggestion that may be displayed to the user`
`31`	`31`	`* to help them choose a better password. The method is`
`32`	`32`	`* required, but a suggestion is optional. May return`
`33`		`- * an empty string instead.`
	`33`	`+ * null instead.`
`34`	`34`	`*/`
`35`	`35`	`public function suggestion(): ?string;`
`36`	`36`	`}`