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

Incorrect async-std example in the quickstart in the README.md #9

Open
ciresnave opened this issue Jul 1, 2024 · 2 comments
Open

Comments

@ciresnave
Copy link

I may have spotted an issue with your documentation. Specifically, in the quickstart section of your README your async-std example appears to be importing from the tokio portion of your library while in the extended example in examples/async_std.rs you import from an async-std portion of your library.

I'm new to your library so maybe I just don't understand and your library's tokio runtime code can be used when the host code is using async-std? I haven't dug into your library's code deep enough to check that.

@ciresnave
Copy link
Author

On a less important note: In the top of the development section of the README, you spelled your crate situwatiion. Since this issue is about a possible error in the README, I figured it was easier to mention it here than open another issue.

@t3hmrman
Copy link
Owner

t3hmrman commented Jul 1, 2024

Hey @ciresnave thanks for taking a look at it -- I think you're absolutely right!

I'm new to your library so maybe I just don't understand and your library's tokio runtime code can be used when the host code is using async-std? I haven't dug into your library's code deep enough to check that.

This is certainly not intended, I'm not even sure that's possible without some intense glue code.

Would you like to submit a patch? Documentation fixes (including misspellings) are PRs I love to push through ASAP!

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

No branches or pull requests

2 participants