docs: clarify Hodges API wording - #205
Merged
Merged
Conversation
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #205 +/- ##
=======================================
Coverage 78.32% 78.32%
=======================================
Files 59 59
Lines 9612 9612
Branches 1867 1867
=======================================
Hits 7529 7529
Misses 1368 1368
Partials 715 715
Flags with carried forward coverage won't be shown. Click here to find out more. |
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
HodgesTracker(track_smoopy_optimization_scale=...)as the parameter controlling numerical scaling in the rectangular GDFP optimizer.workersAPI wording with the supported execution controls:frame_workers,sht_threads, andmge_workers.SimpleTrackerandHealpixTrackercontinue to acceptworkers.Why
The Hodges documentation still used abstract API wording after the v0.7 API cleanup. Naming the affected tracker classes and parameters directly makes the supported interfaces explicit and avoids ambiguous terms such as "development API" or generic references to a "public" parameter.
Validation
docs/hodges.mdchanges.