Skip to content

Commit

Permalink
clarifying the documentation for ApodizationSpec
Browse files Browse the repository at this point in the history
runing ruff
  • Loading branch information
FilipeFcp authored and momchil-flex committed Aug 8, 2024
1 parent 0ff800e commit 61966a9
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 2 deletions.
Binary file added docs/_static/img/apodization.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
10 changes: 8 additions & 2 deletions tidy3d/components/apodization.py
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,13 @@ class ApodizationSpec(Tidy3dBaseModel):
Example
-------
>>> apod_spec = ApodizationSpec(start=1, end=2, width=0.5)
>>> apod_spec = ApodizationSpec(start=1, end=2, width=0.2)
.. image:: ../../_static/img/apodization.png
:width: 80%
:align: center
"""

start: pd.NonNegativeFloat = pd.Field(
Expand All @@ -35,7 +41,7 @@ class ApodizationSpec(Tidy3dBaseModel):
width: pd.PositiveFloat = pd.Field(
None,
title="Apodization Width",
description="Characteristic decay length of the apodization function.",
description="Characteristic decay length of the apodization function, i.e., the width of the ramping up of the scaling function from 0 to 1.",
units=SECOND,
)

Expand Down

0 comments on commit 61966a9

Please sign in to comment.