From 62c689be172a7a06d76fd4b69c3443f3ec053765 Mon Sep 17 00:00:00 2001
From: Hamilton Kibbe <hamilton.kibbe@gmail.com>
Date: Sat, 11 Oct 2014 13:12:21 -0400
Subject: Doc update

---
 gerber/gerber.py | 25 +++++++++++++++++++------
 1 file changed, 19 insertions(+), 6 deletions(-)

(limited to 'gerber/gerber.py')

diff --git a/gerber/gerber.py b/gerber/gerber.py
index 215b970..335b443 100644
--- a/gerber/gerber.py
+++ b/gerber/gerber.py
@@ -15,12 +15,7 @@
 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 # See the License for the specific language governing permissions and
 # limitations under the License.
-"""
-Gerber File module
-==================
-**Gerber File module**
-
-This module provides an RS-274-X class and parser
+""" This module provides an RS-274-X class and parser.
 """
 
 
@@ -34,6 +29,16 @@ from .cam import CamFile, FileSettings
 
 def read(filename):
     """ Read data from filename and return a GerberFile
+
+    Parameters
+    ----------
+    filename : string
+        Filename of file to parse
+
+    Returns
+    -------
+    file : :class:`gerber.gerber.GerberFile`
+        A GerberFile created from the specified file.
     """
     return GerberParser().parse(filename)
 
@@ -113,6 +118,14 @@ class GerberFile(CamFile):
 
     def render(self, ctx, filename=None):
         """ Generate image of layer.
+
+        Parameters
+        ----------
+        ctx : :class:`GerberContext`
+            GerberContext subclass used for rendering the image
+
+        filename : string <optional>
+            If provided, the rendered image will be saved to `filename`
         """
         ctx.set_bounds(self.bounds)
         for statement in self.statements:
-- 
cgit