[DOCs][Filters][Added] Descriptive name

This commit is contained in:
Salvador E. Tropea 2023-08-22 09:36:57 -03:00
parent 9e8c346d35
commit 5bffb57b73
8 changed files with 8 additions and 8 deletions

View File

@ -15,7 +15,7 @@ logger = log.get_logger()
@filter_class @filter_class
class Expand_Text_Vars(BaseFilter): # noqa: F821 class Expand_Text_Vars(BaseFilter): # noqa: F821
""" Expand_Text_Vars """ Expand Text Variables
This filter expands KiCad 6 text variables (${VARIABLE}) """ This filter expands KiCad 6 text variables (${VARIABLE}) """
def __init__(self): def __init__(self):
super().__init__() super().__init__()

View File

@ -17,7 +17,7 @@ logger = log.get_logger()
@filter_class @filter_class
class Field_Modify(BaseFilter): # noqa: F821 class Field_Modify(BaseFilter): # noqa: F821
""" Field_Modify """ Field Modifier
Changes the content of one or more fields """ Changes the content of one or more fields """
def __init__(self): def __init__(self):
super().__init__() super().__init__()

View File

@ -15,7 +15,7 @@ logger = log.get_logger()
@filter_class @filter_class
class Field_Rename(BaseFilter): # noqa: F821 class Field_Rename(BaseFilter): # noqa: F821
""" Field_Rename """ Field Renamer
This filter implements a field renamer. This filter implements a field renamer.
The internal `_kicost_rename` filter emulates the KiCost behavior """ The internal `_kicost_rename` filter emulates the KiCost behavior """
def __init__(self): def __init__(self):

View File

@ -47,7 +47,7 @@ DEFAULT_ROTATIONS = [["^R_Array_Convex_", 90.0],
@filter_class @filter_class
class Rot_Footprint(BaseFilter): # noqa: F821 class Rot_Footprint(BaseFilter): # noqa: F821
""" Rot_Footprint """ Footprint Rotator
This filter can rotate footprints, used for the positions file generation. This filter can rotate footprints, used for the positions file generation.
Some manufacturers use a different rotation than KiCad. Some manufacturers use a different rotation than KiCad.
The internal `_rot_footprint` filter implements the simplest case """ The internal `_rot_footprint` filter implements the simplest case """

View File

@ -58,7 +58,7 @@ class SpecOptions(Optionable):
@filter_class @filter_class
class Spec_to_Field(BaseFilter): # noqa: F821 class Spec_to_Field(BaseFilter): # noqa: F821
""" Spec_to_Field """ Spec to Field
This filter extracts information from the specs obtained from component distributors This filter extracts information from the specs obtained from component distributors
and fills fields. and fills fields.
I.e. create a field with the RoHS status of a component. I.e. create a field with the RoHS status of a component.

View File

@ -15,7 +15,7 @@ logger = log.get_logger()
@filter_class @filter_class
class Value_Split(BaseFilter): # noqa: F821 class Value_Split(BaseFilter): # noqa: F821
""" Value_Split """ Value Splitter
This filter extracts information from the value and fills other fields. This filter extracts information from the value and fills other fields.
I.e. extracts the tolerance and puts it in the `tolerance` field. I.e. extracts the tolerance and puts it in the `tolerance` field.
Usage [example](https://inti-cmnb.github.io/kibot-examples-1/value_split/) """ Usage [example](https://inti-cmnb.github.io/kibot-examples-1/value_split/) """

View File

@ -13,7 +13,7 @@ logger = log.get_logger()
@filter_class @filter_class
class Var_Rename(BaseFilter): # noqa: F821 class Var_Rename(BaseFilter): # noqa: F821
""" Var_Rename """ Variant Renamer
This filter implements the VARIANT:FIELD=VALUE renamer to get FIELD=VALUE when VARIANT is in use """ This filter implements the VARIANT:FIELD=VALUE renamer to get FIELD=VALUE when VARIANT is in use """
def __init__(self): def __init__(self):
super().__init__() super().__init__()

View File

@ -17,7 +17,7 @@ logger = log.get_logger()
@filter_class @filter_class
class Var_Rename_KiCost(BaseFilter): # noqa: F821 class Var_Rename_KiCost(BaseFilter): # noqa: F821
""" Var_Rename_KiCost """ Variant Renamer KiCost style
This filter implements the kicost.VARIANT:FIELD=VALUE renamer to get FIELD=VALUE when VARIANT is in use. This filter implements the kicost.VARIANT:FIELD=VALUE renamer to get FIELD=VALUE when VARIANT is in use.
It applies the KiCost concept of variants (a regex to match the VARIANT). It applies the KiCost concept of variants (a regex to match the VARIANT).
The internal `_var_rename_kicost` filter emulates the KiCost behavior """ The internal `_var_rename_kicost` filter emulates the KiCost behavior """