Skip to content

docs: correct the config-fallback comments on the NNLS warm-start settings (#506) #504

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Jammy2211 merged 1 commit into from
Aug 28, 2026
Merged

docs: correct the config-fallback comments on the NNLS warm-start settings (#506) #504

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 10 additions & 6 deletions autoarray/settings.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -239,9 +239,11 @@ def nnls_warm_start_memo(self) -> bool:
try:
return conf.instance["general"]["inversion"]["nnls_warm_start_memo"]
except KeyError:
# Workspaces ship their own general.yaml that shadows autoarray's
# and will not carry this key, so in practice this fallback *is*
# the production default: on, matching the packaged value.
# A workspace `general.yaml` normally omits this key, so autoconf's
# config-path list falls through to autoarray's packaged value (`true`).
# This fallback fires only when the workspace config is the sole config
# path (isolated test configs push one dir) and returns that same value,
# so both routes resolve identically.
return True

return self._nnls_warm_start_memo
Expand All @@ -261,9 +263,11 @@ def nnls_warm_start_error_tolerance(self) -> float:
"nnls_warm_start_error_tolerance"
]
except KeyError:
# Workspaces ship their own general.yaml that shadows autoarray's
# and will not carry this key, so in practice this fallback *is*
# the production default, matching the packaged value.
# A workspace `general.yaml` normally omits this key, so autoconf's
# config-path list falls through to autoarray's packaged value (`1.5`).
# This fallback fires only when the workspace config is the sole config
# path (isolated test configs push one dir) and returns that same value,
# so both routes resolve identically.
return 1.5

return self._nnls_warm_start_error_tolerance
Expand Down
Loading