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

IMPORTANT section of 3.3 volt ambigious #140

Closed
flip111 opened this issue Feb 17, 2019 · 0 comments
Closed

IMPORTANT section of 3.3 volt ambigious #140

flip111 opened this issue Feb 17, 2019 · 0 comments

Comments

@flip111
Copy link
Contributor

flip111 commented Feb 17, 2019

https://rust-embedded.github.io/book/intro/hardware.html

It's strange that pins and headers are quoted. Assuming a really really hardware nooby here which doesn't know what a pin is, so it has to be quoted to clarify it's a special term.

Then to continue to say IMPORTANT the board works at 3.3 volt without any clarification why that is important or what they user should do.

Suggestion 1:
Think about hardware level knowledge of reader, adjust text accordingly. Not in one section assume a lot of knowledge and in another part assume no knowledge.

Suggestion 2:
Clarify 3.3 volt warning or remove it.

Suggestion 3:
Point to some manufacturer safety document or to the general documentation.

bors bot added a commit that referenced this issue Feb 18, 2019
169: Update hardware.md r=therealprof a=flip111

#140

Co-authored-by: flip111 <[email protected]>
Co-authored-by: Daniel Egger <[email protected]>
@flip111 flip111 closed this as completed Mar 11, 2023
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

1 participant