Skip to content

Commit

Permalink
[docs] Reword OAuth2.Strategy.AuthCode.authorize_url/2 docs
Browse files Browse the repository at this point in the history
I find the existing documentation for `OAuth2.Strategy.AuthCode.authorize_url/2` rather vague/confusing.

If my understanding of its responsibility is correct, this is an attempt to improve its documentation.
  • Loading branch information
mariusbutuc authored Dec 16, 2022
1 parent bd43487 commit dbc55f2
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions lib/oauth2/strategy/auth_code.ex
Original file line number Diff line number Diff line change
Expand Up @@ -27,8 +27,8 @@ defmodule OAuth2.Strategy.AuthCode do
use OAuth2.Strategy

@doc """
The authorization URL endpoint of the provider.
params additional query parameters for the URL
Configures the authorization URL endpoint of the provider with additional
query parameters.
"""
@impl true
def authorize_url(client, params) do
Expand Down

0 comments on commit dbc55f2

Please sign in to comment.