Skip to content

Commit

Permalink
Minor docs change for FluidMedium and SolidMedium
Browse files Browse the repository at this point in the history
  • Loading branch information
marc-flex committed Mar 7, 2025
1 parent 19942bc commit 4436ee0
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 2 deletions.
3 changes: 3 additions & 0 deletions docs/api/heat/mediums.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,9 @@ Material Thermal
:toctree: ../_autosummary/
:template: module.rst

tidy3d.FluidMedium
tidy3d.SolidMedium

tidy3d.FluidSpec
tidy3d.SolidSpec

Expand Down
4 changes: 2 additions & 2 deletions tidy3d/components/material/tcad/heat.py
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ class FluidMedium(AbstractHeatMedium):
Example
-------
>>> solid = FluidSpec()
>>> solid = FluidMedium()
"""


Expand All @@ -62,7 +62,7 @@ class SolidMedium(AbstractHeatMedium):
Example
-------
>>> solid = SolidSpec(
>>> solid = SolidMedium(
... capacity=2,
... conductivity=3,
... )
Expand Down

0 comments on commit 4436ee0

Please sign in to comment.