search

t3hmrman / situwaition

⏲ situwaition is a Rust utility library that waits for conditions
https://crates.io/crates/situwaition
MIT License
6 stars 0 forks source link

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

Open ciresnave opened 5 months ago

ciresnave commented 5 months ago

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 commented 5 months ago

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 commented 5 months ago

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!