add more docstrings

gdsfactory · Jul 28, 2024 · 6f64234 · 6f64234
1 parent 7d9751c
commit 6f64234
Show file tree

Hide file tree

Showing 3 changed files with 11 additions and 5 deletions.
diff --git a/cspdk/si220/__init__.py b/cspdk/si220/__init__.py
@@ -21,6 +21,7 @@
 
 @lru_cache
 def get_pdk() -> Pdk:
+    """Return Cornerstone PDK."""
     return Pdk(
         name="cornerstone_si220",
         cells=_cells,
@@ -33,7 +34,8 @@ def get_pdk() -> Pdk:
     )
 
 
-def activate_pdk():
+def activate_pdk() -> None:
+    """Activate Cornerstone Si220 PDK."""
     pdk = get_pdk()
     pdk.activate()
 

diff --git a/cspdk/si500/__init__.py b/cspdk/si500/__init__.py
@@ -20,7 +20,8 @@
 
 
 @lru_cache
-def get_pdk():
+def get_pdk() -> Pdk:
+    """Return Cornerstone Si500 PDK."""
     return Pdk(
         name="cornerstone_si500",
         cells=_cells,
@@ -33,7 +34,8 @@ def get_pdk():
     )
 
 
-def activate_pdk():
+def activate_pdk() -> None:
+    """Activate Cornerstone Si500 PDK."""
     pdk = get_pdk()
     pdk.activate()
 

diff --git a/cspdk/sin300/__init__.py b/cspdk/sin300/__init__.py
@@ -20,7 +20,8 @@
 
 
 @lru_cache
-def get_pdk():
+def get_pdk() -> Pdk:
+    """Return Cornerstone SiN300 PDK."""
     return Pdk(
         name="cornerstone_sin300",
         cells=_cells,
@@ -33,7 +34,8 @@ def get_pdk():
     )
 
 
-def activate_pdk():
+def activate_pdk() -> None:
+    """Activate Cornerstone SiN300 PDK."""
     pdk = get_pdk()
     pdk.activate()