diff options
| author | Hamilton Kibbe <hamilton.kibbe@gmail.com> | 2015-02-18 23:23:53 -0500 |
|---|---|---|
| committer | Hamilton Kibbe <hamilton.kibbe@gmail.com> | 2015-02-18 23:23:53 -0500 |
| commit | 4db7302485e65937463c2efe3b3c2945549ca588 (patch) | |
| tree | 1d64e366bcba041b2eeb47b94159f89903a487e0 /gerber/operations.py | |
| parent | 5966d7830bda7f37ed5ddcc1bfccb93e7f780eaa (diff) | |
| download | gerbonara-4db7302485e65937463c2efe3b3c2945549ca588.tar.gz gerbonara-4db7302485e65937463c2efe3b3c2945549ca588.tar.bz2 gerbonara-4db7302485e65937463c2efe3b3c2945549ca588.zip | |
Doc update
Diffstat (limited to 'gerber/operations.py')
| -rw-r--r-- | gerber/operations.py | 20 |
1 files changed, 10 insertions, 10 deletions
diff --git a/gerber/operations.py b/gerber/operations.py index 50df738..4eb10e5 100644 --- a/gerber/operations.py +++ b/gerber/operations.py @@ -27,12 +27,12 @@ def to_inch(cam_file): Parameters ---------- - cam_file : `gerber.cam.CamFile` subclass + cam_file : :class:`gerber.cam.CamFile` subclass Gerber or Excellon file to convert Returns ------- - gerber_file : `gerber.cam.CamFile` subclass + cam_file : :class:`gerber.cam.CamFile` subclass A deep copy of the source file with units converted to imperial. """ cam_file = copy.deepcopy(cam_file) @@ -44,12 +44,12 @@ def to_metric(cam_file): Parameters ---------- - cam_file : `gerber.cam.CamFile` subclass + cam_file : :class:`gerber.cam.CamFile` subclass Gerber or Excellon file to convert Returns ------- - gerber_file : `gerber.cam.CamFile` subclass + cam_file : :class:`gerber.cam.CamFile` subclass A deep copy of the source file with units converted to metric. """ cam_file = copy.deepcopy(cam_file) @@ -61,7 +61,7 @@ def offset(cam_file, x_offset, y_offset): Parameters ---------- - cam_file : `gerber.cam.CamFile` subclass + cam_file : :class:`gerber.cam.CamFile` subclass Gerber or Excellon file to offset x_offset : float @@ -72,7 +72,7 @@ def offset(cam_file, x_offset, y_offset): Returns ------- - gerber_file : `gerber.cam.CamFile` subclass + cam_file : :class:`gerber.cam.CamFile` subclass An offset deep copy of the source file. """ cam_file = copy.deepcopy(cam_file) @@ -84,7 +84,7 @@ def scale(cam_file, x_scale, y_scale): Parameters ---------- - cam_file : `gerber.cam.CamFile` subclass + cam_file : :class:`gerber.cam.CamFile` subclass Gerber or Excellon file to scale x_scale : float @@ -95,7 +95,7 @@ def scale(cam_file, x_scale, y_scale): Returns ------- - gerber_file : `gerber.cam.CamFile` subclass + cam_file : :class:`gerber.cam.CamFile` subclass An scaled deep copy of the source file. """ # TODO @@ -106,7 +106,7 @@ def rotate(cam_file, angle): Parameters ---------- - cam_file : `gerber.cam.CamFile` subclass + cam_file : :class:`gerber.cam.CamFile` subclass Gerber or Excellon file to rotate angle : float @@ -114,7 +114,7 @@ def rotate(cam_file, angle): Returns ------- - gerber_file : `gerber.cam.CamFile` subclass + cam_file : :class:`gerber.cam.CamFile` subclass An rotated deep copy of the source file. """ # TODO |