Skip to content

Commit 8445513

Browse files
committed
correct wrong reference to wais_ditance in docs
1 parent 205cf88 commit 8445513

File tree

2 files changed

+2
-2
lines changed

2 files changed

+2
-2
lines changed

tidy3d/components/beam.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -368,7 +368,7 @@ class GaussianBeamProfile(BeamProfile):
368368
title="Waist Distance",
369369
description="Distance from the beam waist along the propagation direction. "
370370
"A positive value means the waist is positioned behind the beam, considering the propagation direction. "
371-
"For example, for a beam propagating in the ``+`` direction, a positive value of ``beam_distance`` "
371+
"For example, for a beam propagating in the ``+`` direction, a positive value of ``waist_distance`` "
372372
"means the beam waist is positioned in the ``-`` direction (behind the beam). "
373373
"A negative value means the beam waist is in the ``+`` direction (in front of the beam). "
374374
"For an angled beam, the distance is defined along the rotated propagation direction.",

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)