fix(adjoint): update docstrings for DerivativeInfo fields #3241
+12
−7
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.
thanks @marcorudolphflex for catching that we had these stale docstrings! Updated here based on recent shape gradient overhaul!
Note
Low Risk
Docstring/type-hint-only changes plus a changelog entry; no functional gradient computation logic is modified.
Overview
Updates
DerivativeInfodocumentation inderivative_utils.pyto match the post-shape-gradient-overhaul semantics:eps_inis now documented/typed as optional (EpsType | None),eps_outand inside/outside meanings are clarified, andcreate_interpolators()docstrings are updated to reflect the current permittivity/interpolator set (including optional H-field interpolators).Adds a corresponding Unreleased changelog note about the
DerivativeInfodocstring corrections.Written by Cursor Bugbot for commit f131d91. This will update automatically on new commits. Configure here.