[DOCs][Added] How to deal with KiCost warnings

Closes #732
INTI-CMNB · Nov 22, 2024 · 2672c86 · 2672c86
1 parent 6487055
commit 2672c86
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 3 deletions.
diff --git a/docs/source/configuration/sup_globals.rst b/docs/source/configuration/sup_globals.rst
@@ -119,7 +119,7 @@
          Used for the value split filter. |br|
          You can use `_field_voltage` as field name to use it in most places.
 
-      -  ``filters`` :index:`: <pair: global options; filters>` [:ref:`list(dict) <list(dict)>`] (default: ``[]``) KiBot warnings to be ignored.
+      -  ``filters`` :index:`: <pair: global options; filters>` [:ref:`list(dict) <list(dict)>`] (default: ``[]``) KiBot and KiCost warnings to be ignored. Add 1000 to KiCost warnings (WCnnn).
 
          -  Valid keys:
 
@@ -216,5 +216,5 @@
       -  ``use_pcb_fields`` :index:`: <pair: global options; use_pcb_fields>` [:ref:`boolean <boolean>`] (default: ``true``) When a PCB is processed also use fields defined in the PCB, for filter and variants processing.
          This is available for KiCad 8 and newer.
       -  ``variant`` :index:`: <pair: global options; variant>` [:ref:`string <string>`] (default: ``''``) Default variant to apply to all outputs.
-      -  ``work_layer`` :index:`: <pair: global options; work_layer>` [:ref:`string <string>`] (default: ``'Margin'``) Layer used for temporal tasks, choose a layer you are not using in your design.
+      -  ``work_layer`` :index:`: <pair: global options; work_layer>` [:ref:`string <string>`] (default: ``'Margin'``) Layer used for temporal tasks, choose a layer you are not using in your design. Affected by global options.
 
diff --git a/kibot/globals.py b/kibot/globals.py
@@ -408,7 +408,8 @@ def __init__(self):
                 The width of the text box will be the width of the image.
                 The text box must contain *kibot_image_X* where X is the output name.
                 This option configures the prefix used. If this option is empty no images will be pasted """
-        self.set_doc('filters', " [list(dict)=[]] KiBot warnings to be ignored ")
+        self.set_doc('filters', " [list(dict)=[]] KiBot and KiCost warnings to be ignored."
+                                " Add 1000 to KiCost warnings (WCnnn) ")
         self._filter_what = 'KiBot warnings'
         self.filters = FilterOptionsKiBot
         self._unknown_is_error = True