From f8449ad2b60b8a715d0867325e257a8297193b49 Mon Sep 17 00:00:00 2001
From: Hamilton Kibbe <hamilton.kibbe@gmail.com>
Date: Tue, 30 Sep 2014 23:42:02 -0400
Subject: tests update

---
 gerber/__init__.py | 11 +++++++++++
 1 file changed, 11 insertions(+)

(limited to 'gerber/__init__.py')

diff --git a/gerber/__init__.py b/gerber/__init__.py
index 089d7b6..e31bd6f 100644
--- a/gerber/__init__.py
+++ b/gerber/__init__.py
@@ -18,6 +18,17 @@
 
 def read(filename):
     """ Read a gerber or excellon file and return a representative object.
+
+    Parameters
+    ----------
+    filename : string
+        Filename of the file to read.
+
+    Returns
+    -------
+    file : CncFile subclass
+        CncFile object representing the file, either GerberFile or
+        ExcellonFile. Returns None if file is not an Excellon or Gerber file.
     """
     import gerber
     import excellon
-- 
cgit