From 7eda7ea873c73f1a5188db74741cae44dc16132b Mon Sep 17 00:00:00 2001 From: Jan Petykiewicz Date: Sun, 16 Sep 2018 20:18:04 -0700 Subject: [PATCH] Clarify docs -- read returns a dict --- masque/file/gdsii.py | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/masque/file/gdsii.py b/masque/file/gdsii.py index 61f20ab..a62e437 100644 --- a/masque/file/gdsii.py +++ b/masque/file/gdsii.py @@ -255,9 +255,9 @@ def read_dtype2dose(filename: str) -> (List[Pattern], Dict[str, Any]): def read(filename: str, use_dtype_as_dose: bool = False, clean_vertices: bool = True, - ) -> (List[Pattern], Dict[str, Any]): + ) -> (Dict[str, Pattern], Dict[str, Any]): """ - Read a gdsii file and translate it into a list of Pattern objects. GDSII structures are + Read a gdsii file and translate it into a dict of Pattern objects. GDSII structures are translated into Pattern objects; boundaries are translated into polygons, and srefs and arefs are translated into SubPattern objects. @@ -268,7 +268,7 @@ def read(filename: str, :param clean_vertices: If true, remove any redundant vertices when loading polygons. The cleaning process removes any polygons with zero area or <3 vertices. Default True. - :return: Tuple: (List of Patterns generated GDSII structures, Dict of GDSII library info) + :return: Tuple: (Dict of pattern_name:Patterns generated from GDSII structures, Dict of GDSII library info) """ with open(filename, mode='rb') as stream: