Skip to content

Commit 3ea7f91

Browse files
committed
style(tools): use triple-quoted DESCRIPTION strings in the renamed tools
The previous commit introduced the new DESCRIPTION values in build-basket and basket-remove-uuids as tuple string concatenation across multiple lines. The project convention, per CONTRIBUTING.md and the example plugin, is a triple-quoted string for DESCRIPTION (and all other triple-quoted strings like docstrings, so `"""..."""` is the single recognisable shape). Rewrite both DESCRIPTION strings accordingly. Functionally identical; ruff / bandit / vulture stay clean.
1 parent 8528a6e commit 3ea7f91

2 files changed

Lines changed: 8 additions & 13 deletions

File tree

tools/basket-remove-uuids

Lines changed: 3 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -22,12 +22,9 @@ except ImportError:
2222
__author__ = 'Linuxfabrik GmbH, Zurich/Switzerland'
2323
__version__ = '2026041301'
2424

25-
DESCRIPTION = (
26-
'Strip the `uuid` fields from an Icinga Director basket JSON so it can '
27-
'be imported into a Director that uses the upstream schema. Linuxfabrik '
28-
'uses a forked Director that keeps uuids; the upstream version does not, '
29-
'and rejects imports that contain them.'
30-
)
25+
DESCRIPTION = """Strip the `uuid` fields from an Icinga Director basket JSON so it can be
26+
imported into a Director that uses the upstream schema. Linuxfabrik uses a forked Director
27+
that keeps uuids; the upstream version does not, and rejects imports that contain them."""
3128

3229

3330
skip_plugins = [

tools/build-basket

Lines changed: 5 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -30,13 +30,11 @@ except ImportError:
3030
__author__ = 'Linuxfabrik GmbH, Zurich/Switzerland'
3131
__version__ = '2026041301'
3232

33-
DESCRIPTION = (
34-
'Generate an Icinga Director basket JSON from a check plugin. Walks '
35-
'the plugin`s argparse definition, turns each parameter into a Director '
36-
'datafield, emits a command and service-template pair, and writes the '
37-
'result into the plugin`s `icingaweb2-module-director/` subdirectory. '
38-
'Use `--auto` to regenerate baskets for every plugin in the repo.'
39-
)
33+
DESCRIPTION = """Generate an Icinga Director basket JSON from a check plugin. Walks the
34+
plugin's argparse definition, turns each parameter into a Director datafield, emits a
35+
command and service-template pair, and writes the result into the plugin's
36+
`icingaweb2-module-director/` subdirectory. Use `--auto` to regenerate baskets for every
37+
plugin in the repo."""
4038

4139
DEFAULT_VARIANTS = [
4240
'linux',

0 commit comments

Comments
 (0)