Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Open
ampinzonv opened this issue May 17, 2023 · 2 comments

Comments

@ampinzonv
Copy link

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?

@FrViPofm
Copy link

FrViPofm commented Jul 29, 2023

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.

@landure
Copy link
Contributor

landure commented Aug 19, 2023

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants