Skip to content

Commit 9d66513

Browse files
committed
[DOCs][Excellon] Warn about left/right digits
It will most probably go away.
1 parent 2fee6dc commit 9d66513

3 files changed

Lines changed: 16 additions & 4 deletions

File tree

docs/samples/generic_plot.kibot.yaml

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1344,7 +1344,9 @@ outputs:
13441344
exclude_filter: '_null'
13451345
# [boolean=true] Generate drill files. Set to False and choose map format if only map is to be generated
13461346
generate_drill_files: true
1347-
# [number=0] number of digits for integer part of coordinates (0 is auto)
1347+
# [number=0] number of digits for integer part of coordinates (0 is auto).
1348+
# Doesn't apply to DECIMAL_FORMAT.
1349+
# Default is 3 and currently can't be configured from the GUI, avoid using it
13481350
left_digits: 0
13491351
# [dict|string='None'] [hpgl,ps,gerber,dxf,svg,pdf,None] Format for a graphical drill map.
13501352
# Not generated unless a format is specified.
@@ -1379,7 +1381,9 @@ outputs:
13791381
# [string=''] Name of the drill report. Not generated unless a name is specified.
13801382
# (%i='drill_report' %x='txt')
13811383
filename: ''
1382-
# [number=0] number of digits for mantissa part of coordinates (0 is auto)
1384+
# [number=0] number of digits for mantissa part of coordinates (0 is auto).
1385+
# Doesn't apply to DECIMAL_FORMAT.
1386+
# Default is 3 and currently can't be configured from the GUI, avoid using it
13831387
right_digits: 0
13841388
# [boolean=true] Use route command for oval holes (G00), otherwise use G85
13851389
route_mode_for_oval_holes: true

docs/source/configuration/outputs/ExcellonOptions.rst

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,8 @@ ExcellonOptions parameters
2222

2323
- ``generate_drill_files`` :index:`: <pair: output - excellon - options; generate_drill_files>` [:ref:`boolean <boolean>`] (default: ``true``) Generate drill files. Set to False and choose map format if only map is to be generated.
2424
- ``left_digits`` :index:`: <pair: output - excellon - options; left_digits>` [:ref:`number <number>`] (default: ``0``) number of digits for integer part of coordinates (0 is auto).
25+
Doesn't apply to DECIMAL_FORMAT. |br|
26+
Default is 3 and currently can't be configured from the GUI, avoid using it.
2527
- ``map`` :index:`: <pair: output - excellon - options; map>` [:ref:`DrillMap parameters <DrillMap>`] [:ref:`dict <dict>` | :ref:`string <string>`] (default: ``'None'``) (choices: "hpgl", "ps", "gerber", "dxf", "svg", "pdf", "None") Format for a graphical drill map.
2628
Not generated unless a format is specified. |br|
2729
KiCad 10 doesn't support HPGL.
@@ -35,6 +37,8 @@ ExcellonOptions parameters
3537
- ``pth_id`` :index:`: <pair: output - excellon - options; pth_id>` [:ref:`string <string>`] Force this replacement for %i when generating PTH and unified files.
3638
- ``report`` :index:`: <pair: output - excellon - options; report>` [:ref:`DrillReport parameters <DrillReport>`] [:ref:`dict <dict>` | :ref:`string <string>`] (default: ``''``) Name of the drill report. Not generated unless a name is specified.
3739
- ``right_digits`` :index:`: <pair: output - excellon - options; right_digits>` [:ref:`number <number>`] (default: ``0``) number of digits for mantissa part of coordinates (0 is auto).
40+
Doesn't apply to DECIMAL_FORMAT. |br|
41+
Default is 3 and currently can't be configured from the GUI, avoid using it.
3842
- ``route_mode_for_oval_holes`` :index:`: <pair: output - excellon - options; route_mode_for_oval_holes>` [:ref:`boolean <boolean>`] (default: ``true``) Use route command for oval holes (G00), otherwise use G85.
3943
- ``table`` :index:`: <pair: output - excellon - options; table>` [:ref:`DrillTable parameters <DrillTable>`] [:ref:`dict <dict>` | :ref:`string <string>`] (default: ``''``) Name of the drill table. Not generated unless a name is specified.
4044
- ``use_aux_axis_as_origin`` :index:`: <pair: output - excellon - options; use_aux_axis_as_origin>` [:ref:`boolean <boolean>`] (default: ``false``) Use the auxiliary axis as origin for coordinates.

kibot/out_excellon.py

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -33,9 +33,13 @@ def __init__(self):
3333
self.zeros_format = 'DECIMAL_FORMAT'
3434
""" [DECIMAL_FORMAT,SUPPRESS_LEADING,SUPPRESS_TRAILING,KEEP_ZEROS] How to handle the zeros """
3535
self.left_digits = 0
36-
""" number of digits for integer part of coordinates (0 is auto) """
36+
""" number of digits for integer part of coordinates (0 is auto).
37+
Doesn't apply to DECIMAL_FORMAT.
38+
Default is 3 and currently can't be configured from the GUI, avoid using it """
3739
self.right_digits = 0
38-
""" number of digits for mantissa part of coordinates (0 is auto) """
40+
""" number of digits for mantissa part of coordinates (0 is auto).
41+
Doesn't apply to DECIMAL_FORMAT.
42+
Default is 3 and currently can't be configured from the GUI, avoid using it """
3943
self.route_mode_for_oval_holes = True
4044
""" Use route command for oval holes (G00), otherwise use G85 """
4145
self._ext = 'drl'

0 commit comments

Comments
 (0)