Skip to content

docs: clarify Hodges API wording - #205

Merged
mwyau merged 1 commit into
mainfrom
docs/api-wording-cleanup
Aug 27, 2026
Merged

docs: clarify Hodges API wording#205
mwyau merged 1 commit into
mainfrom
docs/api-wording-cleanup

Conversation

@mwyau

@mwyau mwyau commented Aug 27, 2026

Copy link
Copy Markdown
Owner

Summary

  • Clarify HodgesTracker(track_smoopy_optimization_scale=...) as the parameter controlling numerical scaling in the rectangular GDFP optimizer.
  • Replace vague Hodges workers API wording with the supported execution controls: frame_workers, sht_threads, and mge_workers.
  • State explicitly that SimpleTracker and HealpixTracker continue to accept workers.

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

  • Reviewed the PR diff; only docs/hodges.md changes.
  • Verified the documented class and parameter names match the v0.7 API.
  • No code, numerical behavior, defaults, or scientific methodology changes.

@mwyau
mwyau marked this pull request as ready for review August 27, 2026 05:22
@mwyau
mwyau merged commit a8d3d54 into main Aug 27, 2026
16 checks passed
@mwyau
mwyau deleted the docs/api-wording-cleanup branch August 27, 2026 05:22
@codecov

codecov Bot commented Aug 27, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 78.32%. Comparing base (7d67ffb) to head (255d1d7).
⚠️ Report is 2 commits behind head on main.
✅ All tests successful. No failed tests found.

Additional details and impacted files

Impacted file tree graph

@@           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           
Flag Coverage Δ
integration 51.63% <ø> (ø)
parity 17.51% <ø> (ø)
unit 57.05% <ø> (ø)
unit-jit-coverage 72.49% <ø> (ø)
unit-jit-disabled 73.83% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

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.

1 participant