Skip to content

Commit 86ea96e

Browse files
Fix: added missing desciptions of a few parameters in docstring (#2619)
* Fix: added missing desciptions of a few parameters in docstring * fixed typos in docstrings
1 parent 0ebf00a commit 86ea96e

File tree

2 files changed

+14
-2
lines changed

2 files changed

+14
-2
lines changed

tidy3d/components/data/unstructured/base.py

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -541,7 +541,7 @@ def from_vtu(
541541
542542
Parameters
543543
----------
544-
fname : str
544+
file : str
545545
Full path to the .vtu file to load the unstructured data from.
546546
field : str = None
547547
Name of the field to load.
@@ -580,14 +580,16 @@ def from_vtk(
580580
581581
Parameters
582582
----------
583-
fname : str
583+
file : str
584584
Full path to the .vtk file to load the unstructured data from.
585585
field : str = None
586586
Name of the field to load.
587587
remove_degenerate_cells : bool = False
588588
Remove explicitly degenerate cells.
589589
remove_unused_points : bool = False
590590
Remove unused points.
591+
remove_invalid_cells : bool = False
592+
Remove invalid cells.
591593
592594
Returns
593595
-------
@@ -697,6 +699,14 @@ def get_cell_values(self, **kwargs):
697699
"""This function returns the cell values for the fields stored in the UnstructuredGridDataset.
698700
If multiple fields are stored per point, like in an IndexedVoltageDataArray, cell values
699701
will be provided for each of the fields unless a selection argument is provided, e.g., voltage=0.2
702+
Parameters
703+
----------
704+
**kwargs : dict
705+
Keyword arguments to pass to the xarray sel() function.
706+
Returns
707+
-------
708+
numpy.ndarray
709+
Extracted data.
700710
"""
701711

702712
values = self.values.sel(**kwargs)

tidy3d/components/data/unstructured/triangular.py

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -614,6 +614,8 @@ def plot(
614614
Type of shading to use when plotting the data field.
615615
cbar_kwargs : Dict = {}
616616
Additional parameters passed to colorbar object.
617+
pcolor_kwargs: Dict = {}
618+
Additional parameters passed to ax.tripcolor()
617619
618620
Returns
619621
-------

0 commit comments

Comments
 (0)