Remove option description from code

[waldekmastykarz]

When building commands, when we define options we need to specify the option's name and description. In the past, both were used to generate command's help. After we moved off of Vorpal and started using markshell for showing help based on .md files, the option description is not serving any purpose other than readability for developers so that looking at option you know instantly what it's for without having to look up the matching .md file.

Is it worth the effort to keep the options' description in code or shall we remove them and keep them only in the command's help in the .md file?

[ValerasNarbutas]

@waldekmastykarz here is my 2 cents on this,
I would say it is not worth it, I do believe in time description in code and md will have more and more differences, which is never beneficial.

[waldekmastykarz]

Appreciate your opinion 😊

[appieschot]

I like the fact that there is a short description per command so that If you are debugging you can quickly find what the command is about. I am not opposed to removing it though, just in my 'way of work' I can quickly scan the command descriptions when working with the code. I do reckon that removing it will give some clarity and prevent duplication or slight differences.

[waldekmastykarz]

With votes in favor, let's remove it.