make _evaluate_circuit an internal function

sax/__init__.py

@@ -14,7 +14,7 @@
 from . import constants
 from . import _typing as typing
 
-from .core import circuit, evaluate_circuit
+from .core import circuit
 from .utils import (
     copy_params,
     get_params,

sax/core.py

@@ -88,7 +88,7 @@ def circuit(**params):
         sdicts = {
             name: model(**params.get(name, {})) for name, model in instances.items()
         }
-        return evaluate_circuit(
+        return _evaluate_circuit(
             sdicts, connections, ports, auto_prune=auto_prune, keep=keep
         )
 
@@ -98,7 +98,7 @@ def circuit(**params):
     return modified_circuit
 
 
-def evaluate_circuit(
+def _evaluate_circuit(
     instances: Dict[str, SDict],
     connections: Dict[str, str],
     ports: Dict[str, str],
@@ -127,29 +127,6 @@ def evaluate_circuit(
 
     Returns:
         the circuit model dictionary with the given port names.
-
-    Example:
-        The SDict for a very simple mzi can for example be evaluated as follows::
-
-            import sax
-            S_mzi = sax.evaluate_circuit(
-                instances = {
-                    "lft": S_coupler,
-                    "top": S_waveguide,
-                    "rgt": S_coupler,
-                },
-                connections={
-                    "lft:out0": "rgt:in0",
-                    "lft:out1": "top:in0",
-                    "top:out0": "rgt:in1",
-                },
-                ports={
-                    "in0": "lft:in0",
-                    "in1": "lft:in1",
-                    "out0": "rgt:out0",
-                    "out1": "rgt:out1",
-                },
-            )
     """
     connections = {  # silently accept YAML netlist syntax
         k.replace(",", ":"): v.replace(",", ":") for k, v in connections.items()