From 8b40d15dab376c92b37b0939515e7bdee7b83301 Mon Sep 17 00:00:00 2001 From: jaseg Date: Sat, 25 Feb 2023 17:31:16 +0100 Subject: Moar doc --- gerbonara/excellon.py | 4 ++++ 1 file changed, 4 insertions(+) (limited to 'gerbonara/excellon.py') diff --git a/gerbonara/excellon.py b/gerbonara/excellon.py index 2653a37..657012b 100755 --- a/gerbonara/excellon.py +++ b/gerbonara/excellon.py @@ -162,6 +162,8 @@ def parse_allegro_logfile(data): return found_tools def parse_zuken_logfile(data): + """ Internal function to parse Excellon format information out of Zuken's nonstandard textual log files that their + tools generate along with the Excellon file. """ lines = [ line.strip() for line in data.splitlines() ] if '***** DRILL LIST *****' not in lines: return # likely not a Zuken CR-8000 logfile @@ -251,9 +253,11 @@ class ExcellonFile(CamFile): self.objects.append(obj_or_comment) def to_excellon(self): + """ Counterpart to :py:meth:`~.rs274x.GerberFile.to_excellon`. Does nothing and returns :py:obj:`self`. """ return self def to_gerber(self): + """ Convert this excellon file into a :py:class:`~.rs274x.GerberFile`. """ apertures = {} out = GerberFile() out.comments = self.comments -- cgit