docs: fix the image reference to the correct waist_distance variable

[FilipeFcp]

Hi @momchil-flex. Thanks for reporting this. It is fixed now.

Greptile Overview

Updated On: 2025-10-08 15:38:54 UTC

Summary

This pull request fixes a documentation inconsistency in the `GaussianBeam` class within `tidy3d/components/source/field.py`. The change corrects a reference in the class docstring's Notes section where `beam_distance` was incorrectly mentioned instead of the actual parameter name `waist_distance`.

The GaussianBeam class defines a parameter called waist_distance (lines 576-586), but the documentation's Notes section was referencing a non-existent beam_distance parameter. This fix ensures the documentation accurately reflects the actual parameter name, maintaining consistency between the class definition and its documentation. This type of fix is important for user experience as it prevents confusion when developers read the docstring and try to use the parameter.

Important Files Changed

Changed Files

Filename	Score	Overview
tidy3d/components/source/field.py	5/5	Fixed documentation inconsistency by correcting parameter name reference from beam_distance to waist_distance

Confidence score: 5/5

• This PR is safe to merge with minimal risk as it only corrects documentation text
• Score reflects a simple documentation fix with no functional code changes that could introduce bugs
• No files require special attention as this is a straightforward text correction

[greptile-apps]

_{1 file reviewed, no comments}

_{Edit Code Review Agent Settings | Greptile}

[github-actions]

Diff Coverage

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

No lines with coverage information in this diff.