Skip to content

Commit aacd909

Browse files
committed
Give documentational consistency to authenticate_with_http_token [ci-skip]
1 parent 20d8750 commit aacd909

File tree

1 file changed

+5
-2
lines changed

1 file changed

+5
-2
lines changed

actionpack/lib/action_controller/metal/http_authentication.rb

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -431,8 +431,11 @@ def authenticate_or_request_with_http_token(realm = "Application", message = nil
431431
authenticate_with_http_token(&login_procedure) || request_http_token_authentication(realm, message)
432432
end
433433

434-
# Authenticate using an HTTP Bearer token. Returns true if
435-
# authentication is successful, false otherwise.
434+
# Authenticate using an HTTP Bearer token.
435+
# Returns the return value of <tt>login_procedure</tt> if a
436+
# token is found. Returns <tt>nil</tt> if no token is found.
437+
#
438+
# See ActionController::HttpAuthentication::Token for example usage.
436439
def authenticate_with_http_token(&login_procedure)
437440
Token.authenticate(self, &login_procedure)
438441
end

0 commit comments

Comments
 (0)