templates
/
KiBot
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

[DOCs][Added] More information about bom.exclude_filter default 

See #560
This commit is contained in:
Salvador E. Tropea 2024-03-19 08:09:01 -03:00
parent e2f3b755b3
commit 8222927d4e
3 changed files with 6 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
docs/samples/generic_plot.kibot.yaml
View File

@ -426,7 +426,8 @@ outputs:
# This option is for simple cases, consider using a full variant for complex cases # This option is for simple cases, consider using a full variant for complex cases
dnf_filter: '_kibom_dnf' dnf_filter: '_kibom_dnf'
# [string|list(string)='_mechanical'] Name of the filter to exclude components from BoM processing. # [string|list(string)='_mechanical'] Name of the filter to exclude components from BoM processing.
# The default filter excludes test points, fiducial marks, mounting holes, etc. # The default filter (built-in filter '_mechanical') excludes test points, fiducial marks, mounting holes, etc.
# Please consult the built-in filters explanation to fully understand what is excluded by default.
# This option is for simple cases, consider using a full variant for complex cases # This option is for simple cases, consider using a full variant for complex cases
exclude_filter: '_mechanical' exclude_filter: '_mechanical'
# [boolean=false] Exclude components marked with *Exclude from BOM* in the PCB. # [boolean=false] Exclude components marked with *Exclude from BOM* in the PCB.

3
docs/source/configuration/outputs/bom.rst
View File

@ -261,7 +261,8 @@ Parameters:
This option is for simple cases, consider using a full variant for complex cases. This option is for simple cases, consider using a full variant for complex cases.
- ``exclude_filter`` :index:`: <pair: output - bom - options; exclude_filter>` [string|list(string)='_mechanical'] Name of the filter to exclude components from BoM processing. - ``exclude_filter`` :index:`: <pair: output - bom - options; exclude_filter>` [string|list(string)='_mechanical'] Name of the filter to exclude components from BoM processing.
The default filter excludes test points, fiducial marks, mounting holes, etc. The default filter (built-in filter '_mechanical') excludes test points, fiducial marks, mounting holes, etc.
Please consult the built-in filters explanation to fully understand what is excluded by default.
This option is for simple cases, consider using a full variant for complex cases. This option is for simple cases, consider using a full variant for complex cases.
- ``exclude_marked_in_pcb`` :index:`: <pair: output - bom - options; exclude_marked_in_pcb>` [boolean=false] Exclude components marked with *Exclude from BOM* in the PCB. - ``exclude_marked_in_pcb`` :index:`: <pair: output - bom - options; exclude_marked_in_pcb>` [boolean=false] Exclude components marked with *Exclude from BOM* in the PCB.

3
kibot/out_bom.py
View File

@ -487,7 +487,8 @@ class BoMOptions(BaseOptions):
This option is for simple cases, consider using a full variant for complex cases """ This option is for simple cases, consider using a full variant for complex cases """
self.exclude_filter = Optionable self.exclude_filter = Optionable
""" [string|list(string)='_mechanical'] Name of the filter to exclude components from BoM processing. """ [string|list(string)='_mechanical'] Name of the filter to exclude components from BoM processing.
The default filter excludes test points, fiducial marks, mounting holes, etc. The default filter (built-in filter '_mechanical') excludes test points, fiducial marks, mounting holes, etc.
Please consult the built-in filters explanation to fully understand what is excluded by default.
This option is for simple cases, consider using a full variant for complex cases """ This option is for simple cases, consider using a full variant for complex cases """
self.dnf_filter = Optionable self.dnf_filter = Optionable
""" [string|list(string)='_kibom_dnf'] Name of the filter to mark components as 'Do Not Fit'. """ [string|list(string)='_kibom_dnf'] Name of the filter to mark components as 'Do Not Fit'.