Remove deprecated apply_eclipse_shadowing! API
#51
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
BREAKING CHANGE: Remove function signature that uses t₁₂ parameter The old signature with parameter order (shape1, r☉₁, R₁₂, t₁₂, shape2) has been removed. Use the new signature (shape1, shape2, r☉₁, r₁₂, R₁₂) which directly accepts shape2's position for better SPICE integration.
- Update test_eclipse_shadowing.jl to use new API signature - Remove obsolete performance comparison test - Update test_visibility_extended.jl to use new API - Remove consistency test between old and new APIs
- Update migration guide to reflect API change - Mark task as completed in ROADMAP.md
MasanoriKanamaru
changed the title
MasanoriKanamaru
changed the title
apply_eclipse_shadowing! API
Document the removal of deprecated apply_eclipse_shadowing! signature in the Unreleased section of CHANGELOG.md
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #51 +/- ##
==========================================
- Coverage 91.77% 91.03% -0.74%
==========================================
Files 14 14
Lines 547 502 -45
==========================================
- Hits 502 457 -45
Misses 45 45 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
- Reorganize sections with Getting Help and Future Deprecations at the top - Add comprehensive migration instructions for removed apply_eclipse_shadowing! signature - Include detailed code examples showing migration from t₁₂ to r₁₂ parameter - Remove outdated references to deprecated API in future deprecations section
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
This PR removes the deprecated
apply_eclipse_shadowing!function signature that uses thet₁₂parameter, as planned in theROADMAP.mdfor v0.5.0.Breaking Changes
(shape1, r☉₁, R₁₂, t₁₂, shape2)(shape1, shape2, r☉₁, r₁₂, R₁₂)Changes
src/eclipse_shadowing.jlROADMAP.mdMigration
Users should update their code from:
To:
Where
r₁₂is shape2's position in shape1's frame (previously computed asr₁₂ = -R₁₂' * t₁₂).Test Results
All tests pass with the updated API.
🤖 Generated with Claude Code