Update dependent code and examples to use snake_case names (Phase 5)#62
Merged
Merged
Conversation
Internal code updates: - murgtools/getdata/getPlotData.py: getALT -> get_alt, docstring update Example updates: - examples/get_latest_argus.py: findArgusImagery -> find_argus_imagery - examples/test_wave_and_imagery.py: getWaveData -> get_wave_data, findArgusImagery -> find_argus_imagery Docstring updates: - _getCurrents_impl, _getWind_impl, _getWL_impl, _getALT_impl docstrings - getArgusPixelIntensity docstring references Closes #53 Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
Contributor
There was a problem hiding this comment.
Pull request overview
This PR continues the multi-phase API rename by updating remaining call sites, examples, and docstrings to use the newer snake_case method/function names (while keeping deprecated aliases available for compatibility).
Changes:
- Updated
getALTusage in plotting utilities toget_alt. - Updated Argus helper references in examples (
findArgusImagery→find_argus_imagery) and wave retrieval (getWaveData→get_wave_data). - Updated internal docstrings to reference snake_case names (e.g.,
get_currents,get_wind,get_wl,get_alt,get_argus_imagery,find_argus_imagery).
Reviewed changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| murgtools/getdata/getPlotData.py | Switches plotting helper code/docstrings to snake_case data-access methods. |
| murgtools/getdata/getDataFRF.py | Updates implementation/docstring references to snake_case method/function names. |
| examples/test_wave_and_imagery.py | Updates example imports and calls to snake_case wave/Argus APIs. |
| examples/get_latest_argus.py | Updates Argus imagery lookup usage to find_argus_imagery. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
|
|
||
| def _getCurrents_impl(self, gaugenumber, roundto): | ||
| """Internal implementation of getCurrents (without caching).""" | ||
| """Internal implementation of get_currents (without caching).""" |
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.
Summary
Updates all internal code, examples, and docstrings to use the new snake_case method names introduced in Phase 3+4.
Changes
Internal Code
murgtools/getdata/getPlotData.py:getALT→get_alt, docstring updatedExamples
examples/get_latest_argus.py:findArgusImagery→find_argus_imageryexamples/test_wave_and_imagery.py:getWaveData→get_wave_datafindArgusImagery→find_argus_imageryDocstrings
getArgusPixelIntensitydocstring updatedTest plan
__init__.pyfor backward compatibilityCloses #53
🤖 Generated with Claude Code