From 231ffa562888cd9b5fc8a23d82e697e19bc6908c Mon Sep 17 00:00:00 2001 From: SET Date: Mon, 17 Aug 2020 19:52:32 -0300 Subject: [PATCH] Added comment about update_xml is no longer needed. --- README.md | 4 +++- docs/samples/generic_plot.kibot.yaml | 4 +++- kibot/pre_update_xml.py | 4 +++- 3 files changed, 9 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 94ce022d..b7b8449c 100644 --- a/README.md +++ b/README.md @@ -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. - 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. -- 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: diff --git a/docs/samples/generic_plot.kibot.yaml b/docs/samples/generic_plot.kibot.yaml index 7753fc09..45395df9 100644 --- a/docs/samples/generic_plot.kibot.yaml +++ b/docs/samples/generic_plot.kibot.yaml @@ -15,7 +15,9 @@ preflight: run_drc: true # [boolean=false] Runs the ERC (Electrical Rules Check). To ensure the schematic is electrically correct 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 outputs: diff --git a/kibot/pre_update_xml.py b/kibot/pre_update_xml.py index eda9dc5d..d6dbff68 100644 --- a/kibot/pre_update_xml.py +++ b/kibot/pre_update_xml.py @@ -17,7 +17,9 @@ logger = get_logger(__name__) @pre_class 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): super().__init__(name, value) if not isinstance(value, bool):