apple / swift-argument-parser

Straightforward, type-safe argument parsing for Swift
Apache License 2.0
3.31k stars 311 forks source link

Add AsyncParsableCommand to README #565

Closed robertmryan closed 10 months ago

robertmryan commented 1 year ago

Update to README and markdown documentation to include easily discovered references to AsyncParsableCommand.

In issue https://github.com/apple/swift-argument-parser/issues/561, I noted that AsyncParsableCommand was not easily discovered. This pull request attempts to remedy this by adding simple references to it in README.md, ArgumentParser.md, and Validation.md. In GettingStarted.md I went so far as to add a new section with an example.

Please note, this only includes documentation changes and does not include any code changes. Therefore, there are no tests for this PR.

Checklist

natecook1000 commented 1 year ago

@swift-ci Please test

rismay commented 10 months ago

This is really hard to discover without documentation. Please merge if possible.

robertmryan commented 10 months ago

FWIW, the status checks said it was out of date, so I went back to my fork and updated it (while preserving my changes). I hope this helps…

natecook1000 commented 10 months ago

@swift-ci Please test