T0: warn on inert PiccoloOptions fields#255
Merged
Merged
Conversation
…zero_initial_and_final_derivative) T0 defect from the 2026-07-08 API-ergonomics audit (spec spec-20260708-140523, armonissima#33). Three PiccoloOptions fields are stored and documented as load-bearing but never consulted anywhere in Piccolo (verified by whole-tree grep): `rollout_integrator` (rollout algorithms are actually chosen by `default_algorithm(system)`), `geodesic`, and `zero_initial_and_final_derivative`. Setting any of them to a non-default value now emits a warning naming the real mechanism / the removal (v2.0); the default path stays silent. Docstrings mark all three DEPRECATED. Fields retained until v2.0 for source compatibility. Visible @warn rather than Base.depwarn: Julia's default --depwarn=no hides depwarn from interactive users, and the point is that a silently-ignored option must not stay silent. Added a testitem asserting each warns on non-default and that defaults / genuinely-consulted fields (bound_state) stay silent; required `using TestItems` in the Options submodule (siblings already import it). Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
aarontrowbridge
force-pushed
the
fix/t0-inert-options
branch
from
d3887ce to
f7e952e
Compare
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
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
1 participant
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.
T0 defect from the API-ergonomics program (spec armonissima#33, tier T0). Piccolo is public/registered, so this is additive (
[A]): a warning + docstring change, no signature or semantics change; the fields stay until v2.0.What
Three
PiccoloOptionsfields are stored and documented as load-bearing but never consulted anywhere in Piccolo (verified by whole-tree grep of.rollout_integrator/.geodesic/.zero_initial_and_final_derivative):rollout_integrator=expv— rollout algorithms are actually chosen bydefault_algorithm(system), so this is doubly misleadinggeodesic=truezero_initial_and_final_derivative=falseChange
@warnnaming the real mechanism and the v2.0 removal. The default path stays silent.bound_state=false) stay silent. (Required addingusing TestItemsto theOptionssubmodule — sibling submodules already import it.)Note
Visible
@warnrather than the file's existingBase.depwarn(used for theverboserename): Julia's default--depwarn=nohidesdepwarnfrom interactive users, and the whole point of this fix is that a silently-ignored option must not stay silent. Happy to switch todepwarnfor consistency if you'd prefer.Testing
🤖 Generated with Claude Code