Skip to content

Conversation

@wtgee
Copy link
Member

@wtgee wtgee commented Sep 19, 2025

I had my pycharm Junie agent go through and add docstrings where missing. There should not be any code or functionality changes.

  • Changes protobuf dependency. (⚠️ not tested ⚠️)
  • Removes unused alignment method and renames current methods so quick-alignment now has alignment as an alias.
  • Adds Junie guidelines to the repo.

@wtgee wtgee requested a review from Copilot September 19, 2025 18:21
Copy link
Contributor

Copilot AI left a 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
Copy link

codecov bot commented Sep 19, 2025

Codecov Report

❌ Patch coverage is 11.11111% with 24 lines in your changes missing coverage. Please review.
✅ Project coverage is 64.46%. Comparing base (f667c04) to head (fc1638b).
⚠️ Report is 13 commits behind head on develop.

Files with missing lines Patch % Lines
src/panoptes/pocs/utils/cli/main.py 0.00% 22 Missing ⚠️
src/panoptes/pocs/mount/mount.py 0.00% 1 Missing ⚠️
src/panoptes/pocs/utils/cli/network.py 0.00% 1 Missing ⚠️
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.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@wtgee wtgee changed the title Add docstrings to all functions and methods. Add docstrings to all functions and methods and other cleanup Sep 19, 2025
@wtgee wtgee merged commit c320e05 into develop Sep 19, 2025
4 of 5 checks passed
@wtgee wtgee deleted the cleanup-20250918 branch September 19, 2025 18:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants