diff --git a/docs/source/configuration/filters/subparts.rst b/docs/source/configuration/filters/subparts.rst index fa3a94941..7db6f5921 100644 --- a/docs/source/configuration/filters/subparts.rst +++ b/docs/source/configuration/filters/subparts.rst @@ -1,15 +1,19 @@ .. Automatically generated by KiBot, please don't edit this file .. index:: - pair: Subparts; subparts + pair: Subparts (**Deprecated**); subparts -Subparts -~~~~~~~~ +Subparts (**Deprecated**) +~~~~~~~~~~~~~~~~~~~~~~~~~ This filter implements the KiCost subparts mechanism. |br| It allows to have more than one part in the same schematic symbol. |br| Some people use it to include connectors and cables related to a connector in the PCB. |br| `KiCost docs `__. |br| + Its use is discouraged, if you want to include extra stuff in your BoM there are much better + mechanisms. You can consolidate extra information from a CSV or complementary schematic. |br| + You can also explicitly add extra components in the schematic and mark them as not for the + PCB. |br| - **comment** :index:`: ` [:ref:`string `] (default: ``''``) A comment for documentation purposes. - **name** :index:`: ` [:ref:`string `] (default: ``''``) Used to identify this particular filter definition. diff --git a/kibot/fil_subparts.py b/kibot/fil_subparts.py index 659184b73..ece53491a 100644 --- a/kibot/fil_subparts.py +++ b/kibot/fil_subparts.py @@ -24,11 +24,15 @@ class DistributorsList(Optionable): @filter_class class Subparts(BaseFilter): # noqa: F821 - """ Subparts + """ Subparts (**Deprecated**) This filter implements the KiCost subparts mechanism. It allows to have more than one part in the same schematic symbol. Some people use it to include connectors and cables related to a connector in the PCB. - [KiCost docs](https://hildogjr.github.io/KiCost/docs/_build/singlehtml/index.html) """ + [KiCost docs](https://hildogjr.github.io/KiCost/docs/_build/singlehtml/index.html). + Its use is discouraged, if you want to include extra stuff in your BoM there are much better + mechanisms. You can consolidate extra information from a CSV or complementary schematic. + You can also explicitly add extra components in the schematic and mark them as not for the + PCB """ def __init__(self): super().__init__() self._is_transform = True