Feat/added option to specify custom command description as array#1982
Open
Benni0 wants to merge 4 commits intosplunk:developfrom
Open
Feat/added option to specify custom command description as array#1982Benni0 wants to merge 4 commits intosplunk:developfrom
Benni0 wants to merge 4 commits intosplunk:developfrom
Conversation
…tion for custom command arguments.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
PR Type
What kind of change does this PR introduce?
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
Tests
See the testing doc.
Demo/meeting:
Reviewers are encouraged to request meetings or demos if any part of the change is unclear