docs(fix): Fix angle spec documentation

[FilipeFcp]

Greptile Overview

Updated On: 2025-10-31 20:43:41 UTC

Greptile Summary

Fixed incorrect class names in the API documentation for plane wave sources.

• Changed tidy3d.FixedInPlaneK to tidy3d.FixedInPlaneKSpec
• Changed tidy3d.FixedAngle to tidy3d.FixedAngleSpec

The documentation previously referenced non-existent class names. The actual classes in the codebase are FixedInPlaneKSpec and FixedAngleSpec, both properly exported in tidy3d/__init__.py. This fix ensures the documentation correctly references the actual API, allowing Sphinx to properly generate documentation links.

Confidence Score: 5/5

• This PR is safe to merge with no risk
• This is a straightforward documentation fix that corrects incorrect class names. The changes align perfectly with the actual class names in the codebase (FixedInPlaneKSpec and FixedAngleSpec), which are properly exported and available in the tidy3d namespace. No code logic is affected, only documentation references.
• No files require special attention

Important Files Changed

File Analysis

Filename	Score	Overview
docs/api/sources.rst	5/5	Fixed incorrect class names in documentation from FixedInPlaneK and FixedAngle to the correct FixedInPlaneKSpec and FixedAngleSpec

Sequence Diagram

sequenceDiagram
    participant Dev as Developer
    participant Docs as Documentation System
    participant Sphinx as Sphinx Builder
    participant API as API Reference

    Dev->>Docs: Update sources.rst with correct class names
    Note over Dev,Docs: FixedInPlaneK → FixedInPlaneKSpec<br/>FixedAngle → FixedAngleSpec
    Docs->>Sphinx: Process RST file
    Sphinx->>API: Generate API documentation
    API->>Sphinx: Import tidy3d.FixedInPlaneKSpec
    API->>Sphinx: Import tidy3d.FixedAngleSpec
    Sphinx-->>Dev: Documentation successfully built

Loading

[greptile-apps]

_{1 file reviewed, no comments}

_{Edit Code Review Agent Settings | Greptile}

[FilipeFcp]

Hi @daquintero . I fixed the names and lumped another small fix to the GaussianBeam docstring

[github-actions]

Diff Coverage

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

No lines with coverage information in this diff.

[FilipeFcp]

Hi @daquinteroflex
Just to confirm, should I merge this myself, or just wait for someone from the solver team to do it?

[daquinteroflex]

Feel free to merge!

[Copilot]

Pull Request Overview

This PR fixes incorrect class names in the API documentation for plane wave sources by updating them to match the actual classes defined in the codebase.

• Corrected tidy3d.FixedInPlaneK to tidy3d.FixedInPlaneKSpec
• Corrected tidy3d.FixedAngle to tidy3d.FixedAngleSpec

---

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.