Skip to content

Incorrect or confusing documentation about Swift versions #677

@rgoldberg

Description

@rgoldberg

Swift Argument Parser 1.3.0+ only supports Swift 5.7+.

The Markdown documentation sometimes mentions Swift 5.5 when it should mention 5.7.

Documentation about the use of obsolete versions of Swift Argument Parser to support Swift 5.5 should indicate that the information is for obsolete versions.

Some of the associated documentation is imprecisely worded. Should be rewritten to clarify.

I won't list out the exact documentation issues here as I already have a branch ready to submit as a PR.

ArgumentParser version:
main branch

Checklist

  • If possible, I've reproduced the issue using the main branch of this package
  • I've searched for existing GitHub issues

Steps to Reproduce

Read the documentation. Notice incorrect or confusing information about Swift versions.

Expected behavior

Not seeing incorrect or confusing documentation about Swift versions.

Actual behavior

Seeing incorrect or confusing documentation about Swift versions.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions