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

Docs refer to wrong version of embedded_hal #2

Open
elpiel opened this issue Feb 27, 2023 · 2 comments
Open

Docs refer to wrong version of embedded_hal #2

elpiel opened this issue Feb 27, 2023 · 2 comments

Comments

@elpiel
Copy link

elpiel commented Feb 27, 2023

The Adc struct of embassy_rp implements Channel from embedded_hal 0.2 but the URL in the docs points to 1.0.0-alpha.9 and once clicked it shows 404.

https://docs.embassy.dev/embassy-rp/git/rp2040/adc/struct.Adc.html#implementations

@peter-lyons-kehl
Copy link

This comes from embassy/embassy-rp > Cargo.toml:

embedded-hal-02 = { package = "embedded-hal", version = "0.2.6", features = ["unproven"] }
embedded-hal-1 = { package = "embedded-hal", version = "=1.0.0-alpha.9", optional = true}

There is https://docs.rs/embedded-hal/0.2.6/embedded_hal/adc/trait.Channel.html, but no counterpart under https://docs.rs/embedded-hal/1.0.0-alpha.9/embedded_hal/index.html.

Any tips, please?

@elpiel
Copy link
Author

elpiel commented Mar 25, 2023

Channel is indeed from 0.2 and I believe it has something to do with the server and this method in particular:

https://github.com/embassy-rs/docserver/blob/main/src/bin/server.rs#L153-L158

But you have to double check this because it seems that this method only handles built crates not external.

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