Skip to content

Commit

Permalink
[DOCs][Subparts filter] Marked as deprecated
Browse files Browse the repository at this point in the history
It uses a dirty hack that is obscure.
Modern KiCad versions has support for things that are schematic only.
  • Loading branch information
set-soft committed Nov 21, 2024
1 parent 312bf7f commit cf75b63
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 5 deletions.
10 changes: 7 additions & 3 deletions docs/source/configuration/filters/subparts.rst
Original file line number Diff line number Diff line change
@@ -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 <https://hildogjr.github.io/KiCost/docs/_build/singlehtml/index.html>`__. |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:`: <pair: filter - subparts; comment>` [:ref:`string <string>`] (default: ``''``) A comment for documentation purposes.
- **name** :index:`: <pair: filter - subparts; name>` [:ref:`string <string>`] (default: ``''``) Used to identify this particular filter definition.
Expand Down
8 changes: 6 additions & 2 deletions kibot/fil_subparts.py
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit cf75b63

Please sign in to comment.