Skip to content

Commit 30aa098

Browse files
Prefer "paramters" over "args" for function documentation.
1 parent 1c879bd commit 30aa098

File tree

4 files changed

+10
-10
lines changed

4 files changed

+10
-10
lines changed

src/planet_auth/auth_client.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -255,7 +255,7 @@ def login(
255255
Authentication parameters are specific to each implementation. Consult
256256
subclass documentation for details.
257257
258-
Args:
258+
Parameters:
259259
allow_open_browser: specify whether login is permitted to open
260260
a browser window.
261261
allow_tty_prompt: specify whether login is permitted to request
@@ -289,7 +289,7 @@ def device_login_complete(self, initiated_login_data: Dict) -> Credential:
289289
"""
290290
Complete a login process that was initiated by a call to `device_login_initiate()`.
291291
292-
Args:
292+
Parameters:
293293
initiated_login_data: The dictionary that was returned by `device_login_initiate()`
294294
295295
Returns:

src/planet_auth/oidc/auth_client.py

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -404,7 +404,7 @@ def login(
404404
flow. The base implementation here handles common config fallback
405405
behaviors. Concrete subclasses must implement the flow specific logic
406406
in a _oidc_flow_login() method.
407-
Args:
407+
Parameters:
408408
allow_open_browser: specify whether login is permitted to open
409409
a browser window.
410410
allow_tty_prompt: specify whether login is permitted to request
@@ -435,7 +435,7 @@ def _warn_password_kwarg(self, **kwargs):
435435
Helper function for _oidc_flow_login implementations to offer guidance to users
436436
and developers when options are unnecessary and will be ignored.
437437
"""
438-
if "password" in kwargs:
438+
if "password" in kwParameters:
439439
if kwargs["password"]:
440440
# Safety check. "password" is a legitimate kwarg for some OAuth flows
441441
# like Resource Owner Flow. But, it should never be provided to the client
@@ -461,7 +461,7 @@ def _warn_ignored_kwargs(self, ignore_kws: list, **kwargs):
461461
is a problem we can anticipate.
462462
"""
463463
for ignore_kw in ignore_kws:
464-
if ignore_kw in kwargs:
464+
if ignore_kw in kwParameters:
465465
if kwargs[ignore_kw]:
466466
auth_logger.debug(
467467
msg=f'Ignoring "{ignore_kw}" argument to login. '
@@ -488,7 +488,7 @@ def refresh(
488488
) -> FileBackedOidcCredential:
489489
"""
490490
Refresh auth tokens using the provided refresh token
491-
Args:
491+
Parameters:
492492
refresh_token: the refresh token to use.
493493
requested_scopes: a list of strings specifying the scopes to
494494
request during the token refresh. If not specified, server

src/planet_auth/oidc/auth_clients/auth_code_flow.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -118,7 +118,7 @@ def _oidc_flow_login(
118118
flow with PKCE. The Auth Code flow is inherently user interactive,
119119
and one of allow_tty_prompt or allow_open_browser must be true.
120120
121-
Args:
121+
Parameters:
122122
allow_open_browser: specify whether login is permitted to open
123123
a browser window.
124124
allow_tty_prompt: specify whether login is permitted to request

src/planet_auth/oidc/auth_clients/device_code_flow.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -86,7 +86,7 @@ def device_login_initiate(
8686
to prompt the user. After prompting the user, `device_login_complete()`
8787
should be called to complete the login process.
8888
89-
Args:
89+
Parameters:
9090
requested_scopes: a list of strings specifying the scopes to
9191
request.
9292
requested_audiences: a list of strings specifying the audiences
@@ -115,7 +115,7 @@ def device_login_complete(self, initiated_login_data: dict) -> FileBackedOidcCre
115115
Obtain tokens from the OIDC auth server using the Device Code OAuth
116116
flow. This method completes the process initiated by a call to `device_login_initiate()`.
117117
118-
Args:
118+
Parameters:
119119
initiated_login_data: The dictionary returned from a successful call to
120120
`device_login_initiate()`
121121
Returns:
@@ -147,7 +147,7 @@ def _oidc_flow_login(
147147
Obtain tokens from the OIDC auth server using the Device Code OAuth
148148
flow.
149149
150-
Args:
150+
Parameters:
151151
requested_scopes: a list of strings specifying the scopes to
152152
request.
153153
requested_audiences: a list of strings specifying the audiences

0 commit comments

Comments
 (0)