From c6ad93dc7868b25faca1f5d809d20df7f7cf8773 Mon Sep 17 00:00:00 2001 From: "Salvador E. Tropea" Date: Thu, 28 Jan 2021 15:36:05 -0300 Subject: [PATCH] Added clarification about the need of dot in edge_cut_extension option. --- README.md | 14 +++++++------- docs/samples/generic_plot.kibot.yaml | 12 ++++++------ kibot/out_any_layer.py | 2 +- 3 files changed, 14 insertions(+), 14 deletions(-) diff --git a/README.md b/README.md index a68425ae..8550d423 100644 --- a/README.md +++ b/README.md @@ -700,7 +700,7 @@ Next time you need this list just use an alias, like this: - `dnf_filter`: [string|list(string)=''] Name of the filter to mark components as not fitted. A short-cut to use for simple cases where a variant is an overkill. - `drill_marks`: [string='full'] what to use to indicate the drill places, can be none, small or full (for real scale). - - `edge_cut_extension`: [string=''] Used to configure the edge cuts layer extension for Protel mode. + - `edge_cut_extension`: [string=''] Used to configure the edge cuts layer extension for Protel mode. Include the dot. - `exclude_edge_layer`: [boolean=true] Do not include the PCB edge layer. - `exclude_pads_from_silkscreen`: [boolean=false] Do not plot the component pads in the silk screen (KiCad 5.x only). - `force_plot_invisible_refs_vals`: [boolean=false] Include references and values even when they are marked as invisible. @@ -802,7 +802,7 @@ Next time you need this list just use an alias, like this: - `disable_aperture_macros`: [boolean=false] Disable aperture macros (workaround for buggy CAM software) (KiCad 6). - `dnf_filter`: [string|list(string)=''] Name of the filter to mark components as not fitted. A short-cut to use for simple cases where a variant is an overkill. - - `edge_cut_extension`: [string=''] Used to configure the edge cuts layer extension for Protel mode. + - `edge_cut_extension`: [string=''] Used to configure the edge cuts layer extension for Protel mode. Include the dot. - `exclude_edge_layer`: [boolean=true] Do not include the PCB edge layer. - `exclude_pads_from_silkscreen`: [boolean=false] Do not plot the component pads in the silk screen (KiCad 5.x only). - `force_plot_invisible_refs_vals`: [boolean=false] Include references and values even when they are marked as invisible. @@ -849,7 +849,7 @@ Next time you need this list just use an alias, like this: - `dnf_filter`: [string|list(string)=''] Name of the filter to mark components as not fitted. A short-cut to use for simple cases where a variant is an overkill. - `drill_marks`: [string='full'] what to use to indicate the drill places, can be none, small or full (for real scale). - - `edge_cut_extension`: [string=''] Used to configure the edge cuts layer extension for Protel mode. + - `edge_cut_extension`: [string=''] Used to configure the edge cuts layer extension for Protel mode. Include the dot. - `exclude_edge_layer`: [boolean=true] Do not include the PCB edge layer. - `exclude_pads_from_silkscreen`: [boolean=false] Do not plot the component pads in the silk screen (KiCad 5.x only). - `force_plot_invisible_refs_vals`: [boolean=false] Include references and values even when they are marked as invisible. @@ -1080,7 +1080,7 @@ Next time you need this list just use an alias, like this: - `dnf_filter`: [string|list(string)=''] Name of the filter to mark components as not fitted. A short-cut to use for simple cases where a variant is an overkill. - `drill_marks`: [string='full'] what to use to indicate the drill places, can be none, small or full (for real scale). - - `edge_cut_extension`: [string=''] Used to configure the edge cuts layer extension for Protel mode. + - `edge_cut_extension`: [string=''] Used to configure the edge cuts layer extension for Protel mode. Include the dot. - `exclude_edge_layer`: [boolean=true] Do not include the PCB edge layer. - `exclude_pads_from_silkscreen`: [boolean=false] Do not plot the component pads in the silk screen (KiCad 5.x only). - `force_plot_invisible_refs_vals`: [boolean=false] Include references and values even when they are marked as invisible. @@ -1104,7 +1104,7 @@ Next time you need this list just use an alias, like this: - `dnf_filter`: [string|list(string)=''] Name of the filter to mark components as not fitted. A short-cut to use for simple cases where a variant is an overkill. - `drill_marks`: [string='full'] what to use to indicate the drill places, can be none, small or full (for real scale). - - `edge_cut_extension`: [string=''] Used to configure the edge cuts layer extension for Protel mode. + - `edge_cut_extension`: [string=''] Used to configure the edge cuts layer extension for Protel mode. Include the dot. - `exclude_edge_layer`: [boolean=true] Do not include the PCB edge layer. - `exclude_pads_from_silkscreen`: [boolean=false] Do not plot the component pads in the silk screen (KiCad 5.x only). - `force_plot_invisible_refs_vals`: [boolean=false] Include references and values even when they are marked as invisible. @@ -1224,7 +1224,7 @@ Next time you need this list just use an alias, like this: - `dnf_filter`: [string|list(string)=''] Name of the filter to mark components as not fitted. A short-cut to use for simple cases where a variant is an overkill. - `drill_marks`: [string='full'] what to use to indicate the drill places, can be none, small or full (for real scale). - - `edge_cut_extension`: [string=''] Used to configure the edge cuts layer extension for Protel mode. + - `edge_cut_extension`: [string=''] Used to configure the edge cuts layer extension for Protel mode. Include the dot. - `exclude_edge_layer`: [boolean=true] Do not include the PCB edge layer. - `exclude_pads_from_silkscreen`: [boolean=false] Do not plot the component pads in the silk screen (KiCad 5.x only). - `force_plot_invisible_refs_vals`: [boolean=false] Include references and values even when they are marked as invisible. @@ -1312,7 +1312,7 @@ Next time you need this list just use an alias, like this: - `dnf_filter`: [string|list(string)=''] Name of the filter to mark components as not fitted. A short-cut to use for simple cases where a variant is an overkill. - `drill_marks`: [string='full'] what to use to indicate the drill places, can be none, small or full (for real scale). - - `edge_cut_extension`: [string=''] Used to configure the edge cuts layer extension for Protel mode. + - `edge_cut_extension`: [string=''] Used to configure the edge cuts layer extension for Protel mode. Include the dot. - `exclude_edge_layer`: [boolean=true] Do not include the PCB edge layer. - `exclude_pads_from_silkscreen`: [boolean=false] Do not plot the component pads in the silk screen (KiCad 5.x only). - `force_plot_invisible_refs_vals`: [boolean=false] Include references and values even when they are marked as invisible. diff --git a/docs/samples/generic_plot.kibot.yaml b/docs/samples/generic_plot.kibot.yaml index c9ddf049..1d80a46c 100644 --- a/docs/samples/generic_plot.kibot.yaml +++ b/docs/samples/generic_plot.kibot.yaml @@ -220,7 +220,7 @@ outputs: dnf_filter: '' # [string='full'] what to use to indicate the drill places, can be none, small or full (for real scale) drill_marks: 'full' - # [string=''] Used to configure the edge cuts layer extension for Protel mode + # [string=''] Used to configure the edge cuts layer extension for Protel mode. Include the dot edge_cut_extension: '' # [boolean=true] Do not include the PCB edge layer exclude_edge_layer: true @@ -350,7 +350,7 @@ outputs: # [string|list(string)=''] Name of the filter to mark components as not fitted. # A short-cut to use for simple cases where a variant is an overkill dnf_filter: '' - # [string=''] Used to configure the edge cuts layer extension for Protel mode + # [string=''] Used to configure the edge cuts layer extension for Protel mode. Include the dot edge_cut_extension: '' # [boolean=true] Do not include the PCB edge layer exclude_edge_layer: true @@ -413,7 +413,7 @@ outputs: dnf_filter: '' # [string='full'] what to use to indicate the drill places, can be none, small or full (for real scale) drill_marks: 'full' - # [string=''] Used to configure the edge cuts layer extension for Protel mode + # [string=''] Used to configure the edge cuts layer extension for Protel mode. Include the dot edge_cut_extension: '' # [boolean=true] Do not include the PCB edge layer exclude_edge_layer: true @@ -737,7 +737,7 @@ outputs: dnf_filter: '' # [string='full'] what to use to indicate the drill places, can be none, small or full (for real scale) drill_marks: 'full' - # [string=''] Used to configure the edge cuts layer extension for Protel mode + # [string=''] Used to configure the edge cuts layer extension for Protel mode. Include the dot edge_cut_extension: '' # [boolean=true] Do not include the PCB edge layer exclude_edge_layer: true @@ -870,7 +870,7 @@ outputs: dnf_filter: '' # [string='full'] what to use to indicate the drill places, can be none, small or full (for real scale) drill_marks: 'full' - # [string=''] Used to configure the edge cuts layer extension for Protel mode + # [string=''] Used to configure the edge cuts layer extension for Protel mode. Include the dot edge_cut_extension: '' # [boolean=true] Do not include the PCB edge layer exclude_edge_layer: true @@ -979,7 +979,7 @@ outputs: dnf_filter: '' # [string='full'] what to use to indicate the drill places, can be none, small or full (for real scale) drill_marks: 'full' - # [string=''] Used to configure the edge cuts layer extension for Protel mode + # [string=''] Used to configure the edge cuts layer extension for Protel mode. Include the dot edge_cut_extension: '' # [boolean=true] Do not include the PCB edge layer exclude_edge_layer: true diff --git a/kibot/out_any_layer.py b/kibot/out_any_layer.py index f72d5f7a..c221bc1b 100644 --- a/kibot/out_any_layer.py +++ b/kibot/out_any_layer.py @@ -67,7 +67,7 @@ class AnyLayerOptions(VariantOptions): The replacement pattern can contain %n for the inner layer number and %N for the layer number. Example '.g%n' """ self.edge_cut_extension = '' - """ Used to configure the edge cuts layer extension for Protel mode """ + """ Used to configure the edge cuts layer extension for Protel mode. Include the dot """ self.custom_reports = CustomReport """ [list(dict)] A list of customized reports for the manufacturer """ super().__init__()