From 267cc38453add4a71a81af0b47373e9654425b1c Mon Sep 17 00:00:00 2001 From: Diego Capusotto Date: Fri, 17 Dec 2021 08:57:45 -0300 Subject: [PATCH] Fixed missing documentation for `route_mode_for_oval_holes` option Closes #123 --- README.md | 2 +- docs/samples/generic_plot.kibot.yaml | 1 + kibot/config_reader.py | 1 + kibot/out_excellon.py | 1 + 4 files changed, 4 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index f86f331a..0c93207d 100644 --- a/README.md +++ b/README.md @@ -993,7 +993,7 @@ Next time you need this list just use an alias, like this: - `filename`: [string=''] Name of the drill report. Not generated unless a name is specified. (%i='drill_report' %x='txt'). - `right_digits`: [number=0] number of digits for mantissa part of coordinates (0 is auto). - - `route_mode_for_oval_holes`: Undocumented. + - `route_mode_for_oval_holes`: [boolean=true] Use route command for oval holes (G00), otherwise use G85. - `use_aux_axis_as_origin`: [boolean=false] Use the auxiliary axis as origin for coordinates. - `zeros_format`: [string='DECIMAL_FORMAT'] [DECIMAL_FORMAT,SUPPRESS_LEADING,SUPPRESS_TRAILING,KEEP_ZEROS] How to handle the zeros. - `output_id`: [string=''] Text to use for the %I expansion content. To differentiate variations of this output. diff --git a/docs/samples/generic_plot.kibot.yaml b/docs/samples/generic_plot.kibot.yaml index 02a1587a..7c074e6c 100644 --- a/docs/samples/generic_plot.kibot.yaml +++ b/docs/samples/generic_plot.kibot.yaml @@ -394,6 +394,7 @@ outputs: filename: '' # [number=0] number of digits for mantissa part of coordinates (0 is auto) right_digits: 0 + # [boolean=true] Use route command for oval holes (G00), otherwise use G85 route_mode_for_oval_holes: true # [boolean=false] Use the auxiliary axis as origin for coordinates use_aux_axis_as_origin: false diff --git a/kibot/config_reader.py b/kibot/config_reader.py index a6ecbfa9..da501d10 100644 --- a/kibot/config_reader.py +++ b/kibot/config_reader.py @@ -477,6 +477,7 @@ def print_output_options(name, cl, indent): entry = ' - `{}`: ' if help is None: help = 'Undocumented' + logger.error('Undocumented option: `{}`'.format(k)) lines = help.split('\n') preface = ind_str+entry.format(k) clines = len(lines) diff --git a/kibot/out_excellon.py b/kibot/out_excellon.py index 6266c119..03e64999 100644 --- a/kibot/out_excellon.py +++ b/kibot/out_excellon.py @@ -32,6 +32,7 @@ class ExcellonOptions(AnyDrill): self.right_digits = 0 """ number of digits for mantissa part of coordinates (0 is auto) """ self.route_mode_for_oval_holes = True + """ Use route command for oval holes (G00), otherwise use G85 """ self._ext = 'drl' def _configure_writer(self, board, offset):