Moved comments in docstrings to comments

- To allow using the docstring of plug-ins for specs
This commit is contained in:
Salvador E. Tropea 2022-07-05 12:42:16 -03:00
parent 35a4cb71ee
commit 53088227d1
9 changed files with 14 additions and 32 deletions

View File

@ -3,9 +3,7 @@
# Copyright (c) 2021 Instituto Nacional de Tecnología Industrial
# License: GPL-3.0
# Project: KiBot (formerly KiPlot)
"""
Implements a field renamer
"""
# Description: Implements a field renamer
from .gs import GS
from .misc import W_EMPTYREN
from .macros import macros, document, filter_class # noqa: F401

View File

@ -3,9 +3,7 @@
# Copyright (c) 2020 Instituto Nacional de Tecnología Industrial
# License: GPL-3.0
# Project: KiBot (formerly KiPlot)
"""
Implements the KiBoM and IBoM filters.
"""
# Description: Implements the KiBoM and IBoM filters.
from re import compile, IGNORECASE
from .optionable import Optionable
from .bom.columnlist import ColumnList

View File

@ -3,10 +3,8 @@
# Copyright (c) 2020-2021 Instituto Nacional de Tecnología Industrial
# License: GPL-3.0
# Project: KiBot (formerly KiPlot)
"""
Implements a filter to rotate footprints.
This is inspired in JLCKicadTools by Matthew Lai.
"""
# Description: Implements a filter to rotate footprints.
# This is inspired in JLCKicadTools by Matthew Lai.
from re import compile
from .gs import GS
from .optionable import Optionable

View File

@ -3,11 +3,9 @@
# Copyright (c) 2021 Instituto Nacional de Tecnología Industrial
# License: GPL-3.0
# Project: KiBot (formerly KiPlot)
"""
Implements the KiCost subparts mechanism.
The 'manf#' field can contain more than one value separated by ;
The result is REF#subpart
"""
# Description: Implements the KiCost subparts mechanism.
# The 'manf#' field can contain more than one value separated by ;
# The result is REF#subpart
import re
from copy import deepcopy
from .gs import GS

View File

@ -3,9 +3,7 @@
# Copyright (c) 2020-2021 Instituto Nacional de Tecnología Industrial
# License: GPL-3.0
# Project: KiBot (formerly KiPlot)
"""
Implements the VARIANT:FIELD=VALUE renamer to get FIELD=VALUE when VARIANT is in use.
"""
# Description: Implements the VARIANT:FIELD=VALUE renamer to get FIELD=VALUE when VARIANT is in use.
from .gs import GS
from .macros import macros, document, filter_class # noqa: F401
from . import log

View File

@ -4,11 +4,9 @@
# License: GPL-3.0
# Project: KiBot (formerly KiPlot)
# The algorithm is from KiCost project (https://github.com/xesscorp/KiCost)
"""
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)
Can be configured, by default is what KiCost does.
"""
# Description: 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)
# Can be configured, by default is what KiCost does.
import re
from .gs import GS
from .macros import macros, document, filter_class # noqa: F401

View File

@ -3,9 +3,7 @@
# Copyright (c) 2020 Instituto Nacional de Tecnología Industrial
# License: GPL-3.0
# Project: KiBot (formerly KiPlot)
"""
Implements the IBoM variants mechanism.
"""
# Description: Implements the IBoM variants mechanism.
from .optionable import Optionable
from .gs import GS
from .misc import IFILT_MECHANICAL

View File

@ -3,9 +3,7 @@
# Copyright (c) 2020 Instituto Nacional de Tecnología Industrial
# License: GPL-3.0
# Project: KiBot (formerly KiPlot)
"""
Implements the KiBoM variants mechanism.
"""
# Description: Implements the KiBoM variants mechanism.
from .optionable import Optionable
from .gs import GS
from .misc import IFILT_MECHANICAL

View File

@ -4,9 +4,7 @@
# License: GPL-3.0
# Project: KiBot (formerly KiPlot)
# The algorithm is from KiCost project (https://github.com/xesscorp/KiCost)
"""
Implements the KiCost variants mechanism.
"""
# Description: Implements the KiCost variants mechanism.
import re
from .gs import GS
from .misc import IFILT_VAR_RENAME_KICOST, IFILT_KICOST_RENAME, IFILT_KICOST_DNP