Skip to content

Commit dd04805

Browse files
committed
doc fix
1 parent 423215d commit dd04805

File tree

2 files changed

+8
-7
lines changed

2 files changed

+8
-7
lines changed

doc/source/workflows/drc/drc.rst

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ Quick start
3434
.. code-block:: python
3535
3636
import pyedb
37-
from pyedb.workflows.drc.drc import DRC, Rules
37+
from pyedb.workflows.drc.drc import Drc, Rules
3838
3939
edb = pyedb.Edb("my_board.aedb")
4040
rules = (
@@ -46,7 +46,7 @@ Quick start
4646
.add_copper_balance("top_bal", max_percent=10, layers=["TOP"])
4747
)
4848
49-
drc = DRC(edb)
49+
drc = Drc(edb)
5050
violations = drc.check(rules)
5151
drc.to_ipc356a("fab_review.ipc")
5252
@@ -92,9 +92,9 @@ DRC engine
9292
:toctree: generated/
9393
:nosignatures:
9494

95-
DRC
96-
DRC.check
97-
DRC.to_ipc356a
95+
Drc
96+
Drc.check
97+
Drc.to_ipc356a
9898

9999
Implementation notes
100100
--------------------
@@ -111,7 +111,7 @@ Add a new rule in three steps:
111111

112112
1. Create a Pydantic model inheriting from ``Pydantic.BaseModel``.
113113
2. Append the model to the ``Rules`` container and expose a fluent helper.
114-
3. Implement ``_rule_<field_name>`` inside ``DRC``; accept the rule instance
114+
3. Implement ``_rule_<field_name>`` inside ``Drc``; accept the rule instance
115115
and append violations to ``self.violations``.
116116

117117
Examples
@@ -135,7 +135,7 @@ Export violations to CSV
135135
136136
import csv
137137
138-
drc = DRC(edb)
138+
drc = Drc(edb)
139139
drc.check(rules)
140140
141141
with open("violations.csv", "w", newline="") as f:

doc/styles/config/vocabularies/ANSYS/accept.txt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -143,3 +143,4 @@ config
143143
job_id
144144
Cohn
145145
Pydantic
146+
Drc

0 commit comments

Comments
 (0)