minor #42409 [Security] Add a little explanations in supports() description (Thaldos)

fabpot · fabpot · commit cb19eb17c15c · 2021-08-09T13:18:26.000+02:00
This PR was squashed before being merged into the 5.4 branch.

Discussion
----------

[Security] Add a little explanations in supports() description

| Q             | A
| ------------- | ---
| Branch?       | 5.4
| Bug fix?      | no
| New feature?  | no
| Deprecations? | no
| Tickets       | -
| License       | MIT
| Doc PR        |  -

It is a very little modification in comment, just to help to understand quickly how the supports() works.

Commits
-------

b585d19de2 [Security] Add a little explanations in supports() description
diff --git a/Authenticator/AuthenticatorInterface.php b/Authenticator/AuthenticatorInterface.php
@@ -34,7 +34,7 @@ interface AuthenticatorInterface
     /**
      * Does the authenticator support the given Request?
      *
-     * If this returns false, the authenticator will be skipped.
+     * If this returns true, authenticate() will be called. If false, the authenticator will be skipped.
      *
      * Returning null means authenticate() can be called lazily when accessing the token storage.
      */

Original file line number	Diff line number	Diff line change
`@@ -34,7 +34,7 @@ interface AuthenticatorInterface`
`34`	`34`	`/**`
`35`	`35`	`* Does the authenticator support the given Request?`
`36`	`36`	`*`
`37`		`- * If this returns false, the authenticator will be skipped.`
	`37`	`+ * If this returns true, authenticate() will be called. If false, the authenticator will be skipped.`
`38`	`38`	`*`
`39`	`39`	`* Returning null means authenticate() can be called lazily when accessing the token storage.`
`40`	`40`	`*/`