Merge pull request rails#51927 from collimarco/patch-1

rafaelfranca · web-flow · commit 8c7745564fc0 · 2024-08-27T14:26:44.000-03:00
Clarify documentation of authenticate_or_request_with_http_token [fix rails#51908] [ci skip]
diff --git a/actionpack/lib/action_controller/metal/http_authentication.rb b/actionpack/lib/action_controller/metal/http_authentication.rb
@@ -431,7 +431,7 @@ module Token
       module ControllerMethods
         # Authenticate using an HTTP Bearer token, or otherwise render an HTTP header
         # requesting the client to send a Bearer token. For the authentication to be
-        # considered successful, `login_procedure` should return a non-nil value.
+        # considered successful, `login_procedure` must not return a false value.
         # Typically, the authenticated user is returned.
         #
         # See ActionController::HttpAuthentication::Token for example usage.

Original file line number	Diff line number	Diff line change
`@@ -431,7 +431,7 @@ module Token`
`431`	`431`	`module ControllerMethods`
`432`	`432`	`# Authenticate using an HTTP Bearer token, or otherwise render an HTTP header`
`433`	`433`	`# requesting the client to send a Bearer token. For the authentication to be`
`434`		- # considered successful, `login_procedure` should return a non-nil value.
	`434`	+ # considered successful, `login_procedure` must not return a false value.
`435`	`435`	`# Typically, the authenticated user is returned.`
`436`	`436`	`#`
`437`	`437`	`# See ActionController::HttpAuthentication::Token for example usage.`