-
Notifications
You must be signed in to change notification settings - Fork 50
Add docstrings to all functions and methods and other cleanup #1377
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
…s to `alignment`. The old `alignment` is now called `long-alignment`
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull Request Overview
This PR adds comprehensive docstrings to functions and methods across the PANOPTES POCS codebase to improve code documentation and usability. The effort was done by a Junie agent to systematically document missing docstrings throughout the project.
Key changes include:
- Addition of module-level docstrings to explain the purpose of each module
- Function and method docstrings with proper parameter descriptions and return value documentation
- Property getter/setter documentation for better API clarity
Reviewed Changes
Copilot reviewed 89 out of 89 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| src/panoptes/pocs/**/*.py | Addition of comprehensive docstrings to all undocumented functions, methods, and modules |
| pyproject.toml | Removed specific protobuf version constraint |
| .junie/guidelines.md | Added project guidelines for Junie agent |
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Codecov Report❌ Patch coverage is Additional details and impacted files@@ Coverage Diff @@
## develop #1377 +/- ##
===========================================
+ Coverage 63.98% 64.46% +0.48%
===========================================
Files 103 103
Lines 9451 9368 -83
Branches 831 831
===========================================
- Hits 6047 6039 -8
+ Misses 3263 3188 -75
Partials 141 141 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
I had my pycharm Junie agent go through and add docstrings where missing. There should not be any code or functionality changes.
protobufdependency. (quick-alignmentnow hasalignmentas an alias.