diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/apertures.rst | 2 | ||||
| -rw-r--r-- | docs/object-api.rst | 15 |
2 files changed, 8 insertions, 9 deletions
diff --git a/docs/apertures.rst b/docs/apertures.rst index 51d4b0f..34a9e91 100644 --- a/docs/apertures.rst +++ b/docs/apertures.rst @@ -17,7 +17,7 @@ Aperture generalization ----------------------- Gerbonara supports rotating both individual graphic objects and whole files. Alas, this was not a use case that was -intended when the Gerber format was developed. We can rotate lines, arcs, and regions alright by simply rotatint all of +intended when the Gerber format was developed. We can rotate lines, arcs, and regions alright by simply rotating all of their points. Flashes are where things get tricky: Individual flashes cannot be rotated at all in any widely supported way. There are some newer additions to the standard, but I would be surprised if any of the cheap board houses understand those. The only way to rotate a flash is to rotate the aperture, not the flash. For cirlces, this is a no-op. diff --git a/docs/object-api.rst b/docs/object-api.rst index f6345b9..796806c 100644 --- a/docs/object-api.rst +++ b/docs/object-api.rst @@ -1,14 +1,13 @@ Graphic Objects =============== -Graphic objects are the lego blocks a gerbonara :py:class:`gerbonara.rs274x.GerberFile` or -:py:class:`gerbonara.excellon.ExcellonFile` is built from. They are stored in the file's -:py:attr:`gerbonara.rs274x.GerberFile.objects` list. You can directly manipulate that list from code. - -There are four graphic object types: :py:class:`gerbonara.graphic_objects.Flash`, -:py:class:`gerbonara.graphic_objects.Line`, :py:class:`gerbonara.graphic_objects.Arc`, and -:py:class:`gerbonara.graphic_objects.Region` . All of them are derived from -:py:class:`gerbonara.graphic_objects.GraphicObject`. +Graphic objects are the lego blocks a gerbonara :py:class:`.GerberFile` or :py:class:`.ExcellonFile` is built from. They +are stored in the file's :py:attr:`~.GerberFile.objects` attribute of a :py:class:`.GerberFile`. You can directly +manipulate that list from code. + +There are four graphic object types: :py:class:`.Flash`, :py:class:`~.graphic_objects.Line`, +:py:class:`~.graphic_objects.Arc`, and :py:class:`~.graphic_objects.Region` . All of them are derived from +:py:class:`~.graphic_objects.GraphicObject`. .. autoclass:: gerbonara.graphic_objects.GraphicObject :members: |