feat: add docstrings to models #48
Merged
Conversation
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
Owner
allisson
commented
Jan 3, 2026
allisson
commented
- Updated README.md with emojis, structured sections, feature highlights, and improved instructions for better user experience and accessibility
- Added descriptive docstrings to Pydantic models and enums in models.py for enhanced code documentation and maintainability
- Updated README.md with emojis, structured sections, feature highlights, and improved instructions for better user experience and accessibility - Added descriptive docstrings to Pydantic models and enums in models.py for enhanced code documentation and maintainability
There was a problem hiding this comment.
Pull request overview
This PR enhances code documentation and improves the README for better user experience. The changes add comprehensive docstrings to all functions, classes, and test methods, while transforming the README into a more engaging and accessible document.
Key Changes:
- Added docstrings to all Python functions, classes, enums, and test methods across the codebase
- Restructured README.md with emojis, clearer sections, and improved formatting for better readability
Reviewed changes
Copilot reviewed 11 out of 12 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| tests/test_qrcode.py | Added docstring to test function |
| tests/test_crypto.py | Added docstrings to encryption/decryption test functions |
| tests/test_api.py | Added docstrings to all API endpoint test functions |
| tests/conftest.py | Added docstrings to pytest fixtures |
| secure_qrcode/qrcode.py | Added docstring to QR code generation function |
| secure_qrcode/models.py | Added docstrings to all Pydantic models and enum class |
| secure_qrcode/exceptions.py | Added docstring to custom exception class |
| secure_qrcode/crypto.py | Added docstrings to cryptographic functions |
| secure_qrcode/config.py | Added docstring to settings class |
| secure_qrcode/api.py | Added docstrings to API endpoint handlers and exception handler |
| README.md | Restructured with emojis, sections, examples, and improved formatting |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
- Update API title capitalization from "Secure QR code" to "Secure QR Code" - Refactor decryption error messages in crypto.py to be more user-friendly, replacing technical exception details with clearer explanations (e.g., "invalid key or corrupted data") - Adjust corresponding test assertion to match the updated error message This enhances user experience by providing more informative error feedback without exposing internal exception details.
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.