Skip to content

Commit d013953

Browse files
committed
Add class description comments
1 parent 3b2b883 commit d013953

File tree

3 files changed

+7
-3
lines changed

3 files changed

+7
-3
lines changed

src/fastapi_oauth2/client.py

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,8 @@
66

77

88
class OAuth2Client:
9+
"""OAuth2 client configuration for a single provider."""
10+
911
backend: Type[BaseOAuth2]
1012
client_id: str
1113
client_secret: str

src/fastapi_oauth2/config.py

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,8 @@
66

77

88
class OAuth2Config:
9+
"""Configuration class of the authentication middleware."""
10+
911
allow_http: bool
1012
jwt_secret: str
1113
jwt_expires: int

src/fastapi_oauth2/core.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -20,12 +20,12 @@
2020

2121

2222
class OAuth2LoginError(HTTPException):
23-
"""Raised when any login-related error occurs
24-
(such as when user is not verified or if there was an attempt for fake login)
25-
"""
23+
"""Raised when any login-related error occurs."""
2624

2725

2826
class OAuth2Strategy(BaseStrategy):
27+
"""Dummy strategy for using the `BaseOAuth2.user_data` method."""
28+
2929
def request_data(self, merge=True):
3030
return {}
3131

0 commit comments

Comments
 (0)