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

Add AsyncParsableCommand to README #565

Merged
merged 2 commits into from Nov 16, 2023
Merged

Conversation

robertmryan
Copy link
Contributor

@robertmryan robertmryan commented Apr 6, 2023

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

In issue #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

  • I've added at least one test that validates that my change is working, if appropriate
  • I've followed the code style of the rest of the project
  • I've read the Contribution Guidelines
  • I've updated the documentation if necessary

@natecook1000
Copy link
Member

@swift-ci Please test

@rismay
Copy link

rismay commented Nov 16, 2023

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

@robertmryan
Copy link
Contributor Author

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
Copy link
Member

@swift-ci Please test

@natecook1000 natecook1000 enabled auto-merge (squash) November 16, 2023 19:13
@natecook1000 natecook1000 merged commit 51ec3ed into apple:main Nov 16, 2023
2 checks passed
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

Successfully merging this pull request may close these issues.

None yet

3 participants