Skip to content

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

Open
@ampinzonv

Description

@ampinzonv

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?

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions