Skip to content

Conversation

@groberts-flex
Copy link
Contributor

@groberts-flex groberts-flex commented Feb 5, 2026

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 DerivativeInfo documentation in derivative_utils.py to match the post-shape-gradient-overhaul semantics: eps_in is now documented/typed as optional (EpsType | None), eps_out and inside/outside meanings are clarified, and create_interpolators() docstrings are updated to reflect the current permittivity/interpolator set (including optional H-field interpolators).

Adds a corresponding Unreleased changelog note about the DerivativeInfo docstring corrections.

Written by Cursor Bugbot for commit f131d91. This will update automatically on new commits. Configure here.

@groberts-flex groberts-flex force-pushed the groberts-flex/FXC-5443-stale-derivative-info-docs branch from bb3147d to f65c472 Compare February 5, 2026 15:55
@github-actions
Copy link
Contributor

github-actions bot commented Feb 5, 2026

Diff Coverage

Diff: origin/develop...HEAD, staged and unstaged changes

  • tidy3d/components/autograd/derivative_utils.py (100%)

Summary

  • Total: 1 line
  • Missing: 0 lines
  • Coverage: 100%

@groberts-flex groberts-flex force-pushed the groberts-flex/FXC-5443-stale-derivative-info-docs branch from f65c472 to a6f2dcc Compare February 5, 2026 20:06
@groberts-flex groberts-flex force-pushed the groberts-flex/FXC-5443-stale-derivative-info-docs branch from a6f2dcc to f131d91 Compare February 6, 2026 14:32
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.

3 participants