Skip to content

Feat/added option to specify custom command description as array#1982

Open
Benni0 wants to merge 4 commits intosplunk:developfrom
Benni0:feat/add_cc_multiline_description
Open

Feat/added option to specify custom command description as array#1982
Benni0 wants to merge 4 commits intosplunk:developfrom
Benni0:feat/add_cc_multiline_description

Conversation

@Benni0
Copy link
Contributor

@Benni0 Benni0 commented Feb 8, 2026

PR Type

What kind of change does this PR introduce?

  • Feature
  • Bug Fix
  • Refactoring (no functional or API changes)
  • Documentation Update
  • Maintenance (dependency updates, CI, etc.)

Summary

Added the possibility to define the description of a custom command as an array of strings, to improve the readability of long comprehensive descriptions in json format. Each string will result in a single line of searchbnf.conf or within the description of the command python.

Changes

Modification of the json schema to allow a string array as description and modified the searchbnf.conf generator and the custom command python generator to format the description accordingly.

This is another update after #1977, #1979 and #1980.

User experience

It is now possible to split long descriptions in multiple lines, which improves the readability in globalConfig.json.

Checklist

If an item doesn't apply to your changes, leave it unchecked.

Review

  • self-review - I have performed a self-review of this change according to the development guidelines
  • Changes are documented. The documentation is understandable, examples work (more info)
  • PR title and description follows the contributing principles
  • meeting - I have scheduled a meeting or recorded a demo to explain these changes (if there is a video, put a link below and in the ticket)

Tests

See the testing doc.

  • Unit - tests have been added/modified to cover the changes
  • Smoke - tests have been added/modified to cover the changes
  • UI - tests have been added/modified to cover the changes
  • coverage - I have checked the code coverage of my changes (see more)

Demo/meeting:

Reviewers are encouraged to request meetings or demos if any part of the change is unclear

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant

Comments