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

Add docs for Hertz structs #186

Merged
merged 4 commits into from
Mar 9, 2020
Merged

Add docs for Hertz structs #186

merged 4 commits into from
Mar 9, 2020

Conversation

jamwaffles
Copy link
Contributor

@jamwaffles jamwaffles commented Feb 16, 2020

Adds docs for the various time structs. I'm using the nightly doc link syntax as it's easier to throw links to stuff everywhere. Build the docs with cargo +nightly doc to see them working. docs.rs already does this so they should render correctly there.

This PR also adds #![deny(intra_doc_link_resolution_failure)] for future use. It's a noop in stable but helps with link checking in nightly. Happy to remove if people don't want it in yet.

TODO

  • Add docs for Hertz
  • Add docs for KiloHertz
  • Add docs for MegaHertz

Cc #158

@jamwaffles jamwaffles marked this pull request as ready for review March 9, 2020 16:11
Copy link
Member

@therealprof therealprof left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, thanks.

@therealprof therealprof merged commit 854526e into stm32-rs:master Mar 9, 2020
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

Successfully merging this pull request may close these issues.

None yet

2 participants