added numpydoc

This commit is contained in:
Hamilton Kibbe 2014-10-01 14:39:32 -04:00
parent ea0dc8d0c8
commit 0b8e2e4b8b
6 changed files with 312 additions and 292 deletions

View file

@ -14,7 +14,12 @@
# 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 module
============
**Gerber Tools**
"""
def read(filename):
""" Read a gerber or excellon file and return a representative object.

View file

@ -14,7 +14,13 @@
# 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.
"""
Excellon module
============
**Excellon file classes**
This module provides Excellon file classes and parsing utilities
"""
import re
from .utils import parse_gerber_value
from .cnc import CncFile, FileSettings

View file

@ -59,9 +59,6 @@ class GerberFile(CncFile):
comments: list of strings
List of comments contained in the gerber file.
units : string
either 'inch' or 'metric'.
size : tuple, (<float>, <float>)
Size in [self.units] of the layer described by the gerber file.