docs: add charge tolerance spec

daquinteroflex · daquinteroflex · commit 43c7183deeb5 · 2025-09-16T13:14:47.000Z
diff --git a/docs/api/spice.rst b/docs/api/spice.rst
@@ -22,3 +22,4 @@ Analysis
    :template: module.rst
 
    tidy3d.IsothermalSteadyChargeDCAnalysis
+   tidy3d.ChargeToleranceSpec
diff --git a/tidy3d/components/spice/analysis/dc.py b/tidy3d/components/spice/analysis/dc.py
@@ -63,7 +63,9 @@ class IsothermalSteadyChargeDCAnalysis(Tidy3dBaseModel):
     )
 
     tolerance_settings: ChargeToleranceSpec = pd.Field(
-        default=ChargeToleranceSpec(), title="Tolerance settings"
+        default=ChargeToleranceSpec(),
+        title="Tolerance settings",
+        description="Charge tolerance parameters relevant to multiple simulation analysis types.",
     )
 
     convergence_dv: pd.PositiveFloat = pd.Field(

Original file line number	Diff line number	Diff line change
`@@ -22,3 +22,4 @@ Analysis`
`22`	`22`	`:template: module.rst`
`23`	`23`
`24`	`24`	`tidy3d.IsothermalSteadyChargeDCAnalysis`
	`25`	`+ tidy3d.ChargeToleranceSpec`
Original file line number	Diff line number	Diff line change
`@@ -63,7 +63,9 @@ class IsothermalSteadyChargeDCAnalysis(Tidy3dBaseModel):`
`63`	`63`	`)`
`64`	`64`
`65`	`65`	`tolerance_settings: ChargeToleranceSpec = pd.Field(`
`66`		`- default=ChargeToleranceSpec(), title="Tolerance settings"`
	`66`	`+ default=ChargeToleranceSpec(),`
	`67`	`+ title="Tolerance settings",`
	`68`	`+ description="Charge tolerance parameters relevant to multiple simulation analysis types.",`
`67`	`69`	`)`
`68`	`70`
`69`	`71`	`convergence_dv: pd.PositiveFloat = pd.Field(`