Skip to content

Commit f0a35da

Browse files
committed
doc(fix): GaussiamBeam: beam_distance -> waist_distance
1 parent dff52fe commit f0a35da

File tree

1 file changed

+1
-1
lines changed

1 file changed

+1
-1
lines changed

tidy3d/components/source/field.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -584,7 +584,7 @@ class GaussianBeam(AngledFieldSource, PlanarSource, BroadbandSource):
584584
title="Waist Distance",
585585
description="Distance from the beam waist along the propagation direction. "
586586
"A positive value means the waist is positioned behind the source, considering the propagation direction. "
587-
"For example, for a beam propagating in the ``+`` direction, a positive value of ``beam_distance`` "
587+
"For example, for a beam propagating in the ``+`` direction, a positive value of ``waist_distance`` "
588588
"means the beam waist is positioned in the ``-`` direction (behind the source). "
589589
"A negative value means the beam waist is in the ``+`` direction (in front of the source). "
590590
"For an angled source, the distance is defined along the rotated propagation direction.",

0 commit comments

Comments
 (0)