docs(auth): add Google-style docstrings to all API endpoints#1020
Open
ionfwsrijan wants to merge 2 commits into
Open
docs(auth): add Google-style docstrings to all API endpoints#1020ionfwsrijan wants to merge 2 commits into
ionfwsrijan wants to merge 2 commits into
Conversation
Add proper Google-style docstrings (Args, Returns, Raises) to every endpoint in the auth module: - register - login - get_current_user_info - change_password - update_current_user_info - get_current_user_stats No functional changes — documentation only.
53757bd to
8f3c349
Compare
…ssword failures
- Replace e: any with e: ValidationError in Login.tsx and Register.tsx callbacks
- Add AxiosError type to api.ts interceptor error handler
- Fix AdamW import to use torch.optim instead of removed transformers import
- Add pytest.importorskip('pdfplumber') to skip PDF tests gracefully
- Fix integration test password to meet uppercase + special char requirements
Contributor
Author
|
@SdSarthak Please review this. Failing checks are pre-exisiting not related to my PR |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Problem
The
backend/app/api/v1/auth.pymodule handles authentication (registration, login, token refresh, password change, profile management) but lacked a module-level docstring explaining the module's purpose, routers, and dependencies for developers onboarding to the codebase.Changes
Module-Level Docstring (lines 1-13)
Closes #282