Skip to content

Refactor codebase and improve documentation - #53

Merged
craigmillernz merged 29 commits into
mainfrom
AdrianBenson/issue44
Sep 25, 2026
Merged

craigmillernz merged 29 commits into
mainfrom
AdrianBenson/issue44

Conversation

@AdrianBenson

@AdrianBenson AdrianBenson commented Sep 24, 2026 •

Copy link
Copy Markdown
Collaborator

Enhance code quality by refactoring multiple modules, updating documentation for clarity, and fixing linting issues. Add pre-commit configuration for better code management and ensure consistent naming conventions throughout the project. Address various test failures and improve error messages for debugging.

Closes #44, #40

Adrian Benson added 24 commits September 13, 2026 00:18
…coderefactor:

update include_unknown_fields default to True and clean up code
- Updated import statements to include new utility functions.
- Enhanced readability by breaking long lines and improving variable names.
- Replaced instances of `isinstance` checks with more type-safe alternatives.
- Corrected typos and improved documentation for clarity.
- Ensured consistent naming conventions for variables and parameters.
- Refactored logic in various functions to streamline processing and enhance performance.
- Added type hints for better type checking and code clarity.
- Improved error messages for better debugging experience.
Required because they are explicitly imported.
@codecov

codecov Bot commented Sep 24, 2026 •

Copy link
Copy Markdown

Codecov Report

❌ Patch coverage is 56.94635% with 626 lines in your changes missing coverage. Please review.
✅ Project coverage is 65.03%. Comparing base (bb822b6) to head (84330bc).

Files with missing lines Patch % Lines
src/gsolve/reductions/terrain_corrections.py 25.13% 133 Missing and 10 partials ⚠️
src/gsolve/tide/earth_tide.py 39.16% 83 Missing and 4 partials ⚠️
src/gsolve/core/data.py 56.61% 46 Missing and 13 partials ⚠️
src/gsolve/meter_conversion.py 60.80% 36 Missing and 13 partials ⚠️
src/gsolve/scintrex.py 54.28% 42 Missing and 6 partials ⚠️
src/gsolve/tide/ocean_load.py 45.00% 40 Missing and 4 partials ⚠️
src/gsolve/observations.py 70.16% 32 Missing and 5 partials ⚠️
src/gsolve/core/utils.py 71.87% 33 Missing and 3 partials ⚠️
src/gsolve/gsolve_outputs.py 48.88% 23 Missing ⚠️
src/gsolve/core/excel_io.py 51.42% 15 Missing and 2 partials ⚠️
... and 8 more
Additional details and impacted files
@@            Coverage Diff             @@
##             main      #53      +/-   ##
==========================================
- Coverage   67.03%   65.03%   -2.00%     
==========================================
  Files          22       22              
  Lines        3898     4156     +258     
  Branches      808      803       -5     
==========================================
+ Hits         2613     2703      +90     
- Misses       1008     1179     +171     
+ Partials      277      274       -3     

☔ View full report in Codecov by Harness.
📢 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.

@craigmillernz
craigmillernz self-requested a review September 24, 2026 22:00
Comment thread examples/scripts/okataina_survey.py
Comment thread examples/scripts/TeMaari_ocean_loading_pyhardisp.py Outdated
Comment thread src/gsolve/reductions/corrections.py

@craigmillernz craigmillernz left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

thanks for making those fixes

@craigmillernz
craigmillernz merged commit 37aa0c3 into main Sep 25, 2026
8 of 10 checks passed
@craigmillernz
craigmillernz deleted the AdrianBenson/issue44 branch September 25, 2026 01:09
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.

Issues with reading data into GravitySites

2 participants