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
AsyncParsableCommand documentation #561
Comments
I don't think we can detect that this is happening. Ideally Swift would warn for this near-miss implementation, but since the
A PR for this would be great, thank you! |
* See issue apple#561
@natecook1000 - I have submitted PR #565 with an attempt to make Needless to say, feel free to make whatever changes you want. My intent was simply to move the ball forward. |
Right now, if you supply an
async
rendition ofrun()
in conjunction withParsableCommand
, it produces no warning or error, but whenever you run the app, you simply see the “USAGE” text. It took a surprising/unnecessary amount of time pouring through the class library and looking at a particular code sample, before I stumbled acrossAsyncParsableCommand
.Ideally, it would be great to produce a meaningful warning/error when a valid
run()
is not found. It obviously fell through to a point where “USAGE” text was displayed. Is it possible to give us some warning why we got the “USAGE” text?I would suggest that the
README.md
and the documentation introduction make some reference toAsyncParsableCommand
forasync
renditions ofrun()
. This should be more easily discovered.If you would like me to take a pass at a PR to that end, please let me know.
The text was updated successfully, but these errors were encountered: