shdoc icon indicating copy to clipboard operation
shdoc copied to clipboard

Warning and error in doc generation when short"-" or long "--" are used in @arg

Open ampinzonv opened this issue 2 years ago • 2 comments

My functions use the long and short options format. For example:

#
# @arg -s/--sequence (optional) Show sequence.
# @arg -j/--jobs     (optional) Number of CPU cores to use.
#

When running shdoc over my scripts the following message appears:

line   44, warning : Invalid format: @arg -s/--sequence (optional) Show sequence.
line   45, warning : Invalid format: @arg -j/--jobs     (optional) Number of CPU cores to use.

And the generated .md output is incomplete and/or truncated.

¿Is there a way to fix it? ¿Si something from my side?

ampinzonv avatar May 17 '23 16:05 ampinzonv

It is boring that none of the @arg -c nor @option -c features are working today as we often use parameters/options on shell scripts and cannot comment them.

FrViPofm avatar Jul 29 '23 09:07 FrViPofm

Hi, with the last version @option -s | --sequence (optional) Show sequence. should work.

landure avatar Aug 19 '23 08:08 landure