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

Added comment about update_xml is no longer needed.

This commit is contained in:
SET 2020-08-17 19:52:32 -03:00
parent cd6c1d5ba4
commit 231ffa5628
3 changed files with 9 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
README.md
View File

@ -70,7 +70,9 @@ This section is used to specify tasks that will be executed before generating an
- ignore_unconnected: [boolean=false] Option for `run_drc`. Ignores the unconnected nets. Useful if you didn't finish the routing. - ignore_unconnected: [boolean=false] Option for `run_drc`. Ignores the unconnected nets. Useful if you didn't finish the routing.
- run_drc: [boolean=false] Runs the DRC (Distance Rules Check). To ensure we have a valid PCB. - run_drc: [boolean=false] Runs the DRC (Distance Rules Check). To ensure we have a valid PCB.
- run_erc: [boolean=false] Runs the ERC (Electrical Rules Check). To ensure the schematic is electrically correct. - run_erc: [boolean=false] Runs the ERC (Electrical Rules Check). To ensure the schematic is electrically correct.
- update_xml: [boolean=false] Update the XML version of the BoM (Bill of Materials). To ensure our generated BoM is up to date. - update_xml: [boolean=false] Update the XML version of the BoM (Bill of Materials).
To ensure our generated BoM is up to date.
Note that this isn't needed when using the internal BoM generator (`bom`).
Here is an example of a *preflight* section: Here is an example of a *preflight* section:

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

@ -15,7 +15,9 @@ preflight:
run_drc: true run_drc: true
# [boolean=false] Runs the ERC (Electrical Rules Check). To ensure the schematic is electrically correct # [boolean=false] Runs the ERC (Electrical Rules Check). To ensure the schematic is electrically correct
run_erc: true run_erc: true
# [boolean=false] Update the XML version of the BoM (Bill of Materials). To ensure our generated BoM is up to date # [boolean=false] Update the XML version of the BoM (Bill of Materials).
To ensure our generated BoM is up to date.
Note that this isn't needed when using the internal BoM generator (`bom`)
update_xml: true update_xml: true
outputs: outputs:

4
kibot/pre_update_xml.py
View File

@ -17,7 +17,9 @@ logger = get_logger(__name__)
@pre_class @pre_class
class Update_XML(BasePreFlight): # noqa: F821 class Update_XML(BasePreFlight): # noqa: F821
""" [boolean=false] Update the XML version of the BoM (Bill of Materials). To ensure our generated BoM is up to date """ """ [boolean=false] Update the XML version of the BoM (Bill of Materials).
To ensure our generated BoM is up to date.
Note that this isn't needed when using the internal BoM generator (`bom`) """
def __init__(self, name, value): def __init__(self, name, value):
super().__init__(name, value) super().__init__(name, value)
if not isinstance(value, bool): if not isinstance(value, bool):