Skip to content

Change help documentation interface #6

@zph

Description

@zph

For flexibility, instead of USAGE: or SUMMARY: we could make the following interface:

  1. USAGE is the first line after the #! that is not empty or empty after stripping leading comment chars
  2. Full Description from USAGE (inclusive) until first line that is empty with no comment chars OR where it starts with non-comment char

Then the user can choose to use these strict patterns (usage:) for better interface but doesn't require as much control over design of the scripts.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions