Skip to content

Commit

Permalink
Rename add_trace to add_line_trace for consistency
Browse files Browse the repository at this point in the history
  • Loading branch information
Argmaster committed Nov 9, 2024
1 parent 70f7056 commit b063e3a
Show file tree
Hide file tree
Showing 6 changed files with 28 additions and 28 deletions.
10 changes: 5 additions & 5 deletions docs/80_code_generation/10_gerber.md
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ For full reference of shapes available in `PadCreator` check out

[`GerberX3Builder`](../reference/pygerber/builder/gerber.md#pygerber.builder.gerber.GerberX3Builder)
class also provides means to add traces to the Gerber image. You can use
[`new_trace()`](../reference/pygerber/builder/gerber.md#pygerber.builder.gerber.GerberX3Builder.add_trace)
[`new_trace()`](../reference/pygerber/builder/gerber.md#pygerber.builder.gerber.GerberX3Builder.add_line_trace)
and
[`add_clockwise_arc_trace()`](../reference/pygerber/builder/gerber.md#pygerber.builder.gerber.GerberX3Builder.add_clockwise_arc_trace)
methods to do that. Fist one creates a straight lines, second one creates arcs. You
Expand Down Expand Up @@ -95,10 +95,10 @@ with PyGerber:

## Using objects as locations

Commands creating graphical elements, like `add_pad()` or `add_trace()` return special
`Draw` objects (`PadDraw` or `TraceDraw` respectively) which can be used as locations
for `new_pad()` or `new_trace()` method calls. This way you don not have to retype
coordinates for draws which are connected to previous objects.
Commands creating graphical elements, like `add_pad()` or `add_line_trace()` return
special `Draw` objects (`PadDraw` or `TraceDraw` respectively) which can be used as
locations for `new_pad()` or `new_trace()` method calls. This way you don not have to
retype coordinates for draws which are connected to previous objects.

!!! warning

Expand Down
10 changes: 5 additions & 5 deletions src/pygerber/builder/gerber.py
Original file line number Diff line number Diff line change
Expand Up @@ -163,8 +163,8 @@ def add_pad(
Previously defined pad object to be used for drawing.
at : Loc2D | TraceDraw
Location to flash at. Can be a 2-tuple of floats or TraceDraw object
returned from `add_trace()` or `add_clockwise_arc_trace()`, then the end
location of that trace will be used.
returned from `add_line_trace()` or `add_clockwise_arc_trace()`, then the
end location of that trace will be used.
rotation : float, optional
Pad rotation (rotation around pad origin), by default 0.0
mirror_x : bool, optional
Expand Down Expand Up @@ -288,8 +288,8 @@ def add_cutout_pad(
Previously defined pad object to be used for drawing.
at : Loc2D | TraceDraw
Location to flash at. Can be a 2-tuple of floats or TraceDraw object
returned from `add_trace()` or `add_clockwise_arc_trace()`, then the end
location of that trace will be used.
returned from `add_line_trace()` or `add_clockwise_arc_trace()`, then the
end location of that trace will be used.
rotation : float, optional
Pad rotation (rotation around pad origin), by default 0.0
mirror_x : bool, optional
Expand Down Expand Up @@ -335,7 +335,7 @@ def add_cutout_pad(
self._add_draw(draw)
return draw

def add_trace(
def add_line_trace(
self,
width: float,
begin: Loc2D | PadDraw | TraceDraw,
Expand Down
2 changes: 1 addition & 1 deletion src/pygerber/gerber/pygments.py
Original file line number Diff line number Diff line change
Expand Up @@ -98,7 +98,7 @@ class PyGerberDocsLexer(PythonLexer):
"new_pad": Name.Function,
"add_pad": Name.Function,
"add_cutout_pad": Name.Function,
"add_trace": Name.Function,
"add_line_trace": Name.Function,
"add_clockwise_arc_trace": Name.Function,
"add_counter_clockwise_arc_trace": Name.Function,
"get_code": Name.Function,
Expand Down
4 changes: 2 additions & 2 deletions test/examples/builder/gerber/_10_circle_pad_and_trace.ex.py
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,8 @@

d10 = builder.new_pad().circle(diameter=0.5)
builder.add_pad(d10, (2, 1))
builder.add_trace(0.1, (0, 0), (0, 1))
builder.add_trace(0.1, (0, 1), (2, 1))
builder.add_line_trace(0.1, (0, 0), (0, 1))
builder.add_line_trace(0.1, (0, 1), (2, 1))

code = builder.get_code()
print(code.dumps())
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,8 @@
pad_0 = builder.add_pad(d10, (0, 0))
pad_1 = builder.add_pad(d10, (2, 1))

trace_0 = builder.add_trace(0.1, pad_0, (0, 1))
builder.add_trace(0.1, trace_0, pad_1)
trace_0 = builder.add_line_trace(0.1, pad_0, (0, 1))
builder.add_line_trace(0.1, trace_0, pad_1)


code = builder.get_code()
Expand Down
26 changes: 13 additions & 13 deletions test/test_builder/test_gerber.py
Original file line number Diff line number Diff line change
Expand Up @@ -615,7 +615,7 @@ def test_two_complicated(

class TestTraces:
def test_one_trace(self, builder: GerberX3Builder, default_header: str) -> None:
builder.add_trace(0.1, (0, 0), (1, 1))
builder.add_line_trace(0.1, (0, 0), (1, 1))
assert (
builder.get_code().dumps()
== f"""{default_header}
Expand All @@ -632,8 +632,8 @@ def test_one_trace(self, builder: GerberX3Builder, default_header: str) -> None:
def test_two_traces_same_width(
self, builder: GerberX3Builder, default_header: str
) -> None:
builder.add_trace(0.1, (0, 0), (1, 1))
builder.add_trace(0.1, (1, 1), (1, 2))
builder.add_line_trace(0.1, (0, 0), (1, 1))
builder.add_line_trace(0.1, (1, 1), (1, 2))
assert (
builder.get_code().dumps()
== f"""{default_header}
Expand All @@ -651,8 +651,8 @@ def test_two_traces_same_width(
def test_two_traces_different_width(
self, builder: GerberX3Builder, default_header: str
) -> None:
builder.add_trace(0.1, (0, 0), (1, 1))
builder.add_trace(0.2, (1, 1), (1, 2))
builder.add_line_trace(0.1, (0, 0), (1, 1))
builder.add_line_trace(0.2, (1, 1), (1, 2))
assert (
builder.get_code().dumps()
== f"""{default_header}
Expand All @@ -670,9 +670,9 @@ def test_two_traces_different_width(
)

def test_three_traces(self, builder: GerberX3Builder, default_header: str) -> None:
builder.add_trace(0.1, (0, 0), (1, 1))
builder.add_trace(0.2, (1, 1), (1, 2))
builder.add_trace(0.1, (1, 2), (2, 1))
builder.add_line_trace(0.1, (0, 0), (1, 1))
builder.add_line_trace(0.2, (1, 1), (1, 2))
builder.add_line_trace(0.1, (1, 2), (2, 1))
assert (
builder.get_code().dumps()
== f"""{default_header}
Expand All @@ -694,8 +694,8 @@ def test_three_traces(self, builder: GerberX3Builder, default_header: str) -> No
def test_two_traces_discontinued(
self, builder: GerberX3Builder, default_header: str
) -> None:
builder.add_trace(0.1, (0, 0), (1, 1))
builder.add_trace(0.1, (2, 2), (3, 3))
builder.add_line_trace(0.1, (0, 0), (1, 1))
builder.add_line_trace(0.1, (2, 2), (3, 3))
assert (
builder.get_code().dumps()
== f"""{default_header}
Expand All @@ -719,7 +719,7 @@ def test_trace_connect_two_pads(
pad0 = builder.add_pad(pad, (0, 0))
pad1 = builder.add_pad(pad, (2, 2))

builder.add_trace(0.1, pad0, pad1)
builder.add_line_trace(0.1, pad0, pad1)

assert (
builder.get_code().dumps()
Expand All @@ -746,8 +746,8 @@ def test_two_trace_connect_two_pads(
pad0 = builder.add_pad(pad, (0, 0))
pad1 = builder.add_pad(pad, (2, 2))

trace0 = builder.add_trace(0.1, pad0, (1, 1))
builder.add_trace(0.1, trace0, pad1)
trace0 = builder.add_line_trace(0.1, pad0, (1, 1))
builder.add_line_trace(0.1, trace0, pad1)

assert (
builder.get_code().dumps()
Expand Down

0 comments on commit b063e3a

Please sign in to comment.