fix docs

gdsfactory · Sep 19, 2023 · 941b515 · 941b515
1 parent ed7450c
commit 941b515
Show file tree

Hide file tree

Showing 3 changed files with 5 additions and 5 deletions.
diff --git a/docs/notebooks/femwell_02_heater.py b/docs/notebooks/femwell_02_heater.py
@@ -11,7 +11,7 @@
 from gdsfactory.technology import LayerStack
 from skfem.io import from_meshio
 
-from gplugins.gmsh.mesh import create_physical_mesh, get_mesh
+from gplugins.gmsh import create_physical_mesh, get_mesh
 
 gf.config.rich_output()
 PDK = get_generic_pdk()

diff --git a/gplugins/gmsh/mesh.py b/gplugins/gmsh/mesh.py
@@ -18,7 +18,7 @@
 )
 
 
-def define_entities(model, shapes_dict: OrderedDict, atol=1e-3):
+def define_entities(model, shapes_dict: OrderedDict, atol: float = 1e-3):
     """Adds the polygons and lines from a "shapes_dict" as physical entities in the pygmsh model "model".
 
     Args:
@@ -127,7 +127,7 @@ def mesh_from_polygons(
     verbosity: bool | None = False,
     atol: float | None = 1e-4,
     periodic_lines: tuple[(str, str)] | None = None,
-):
+) -> meshio.Mesh:
     """Return a 2D mesh from an ordered dict of shapely polygons.
 
     Args:
@@ -222,7 +222,7 @@ def mesh_from_polygons(
     return mesh
 
 
-def create_physical_mesh(mesh, cell_type):
+def create_physical_mesh(mesh, cell_type) -> meshio.Mesh:
     cells = mesh.get_cells_type(cell_type)
     cell_data = mesh.get_cell_data("gmsh:physical", cell_type)
     points = mesh.points

diff --git a/gplugins/gmsh/parse_component.py b/gplugins/gmsh/parse_component.py
@@ -176,7 +176,7 @@ def create_2D_surface_interface(
         layer_polygons: shapely polygons.
         thickness_min: distance to define the interfacial region towards the polygon.
         thickness_max: distance to define the interfacial region away from the polygon.
-        simplify: simplification factor for over-parametrized geometries
+        simplify: simplification factor for over-parametrized geometries.
 
     Returns:
         shapely interface polygon