Skip to content

Clean up imports, fix doc lints, get doctests to pass #59

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

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

trappitsch
Copy link

As discussed in #58, this cleans up the following:

  • Remove the unused imports that are behind feature gates that don't exist anymore
  • Clean up lints for documentation

This cleanup also made the example in measurements.rs discoverable as a doc test, and it didn't pass due to the ![no_std] configuration. Removed the ![no_std] configuration in the example, reordered the description such that the example now also shows up in the docs, and added a note that in no_std environments, use core as std is required when using the macros.

Copy link
Member

@thejpster thejpster left a comment

Choose a reason for hiding this comment

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

Looks good - one suggestion to discuss

///
/// It provides conversion functions to and from raw numbers.
/// *Note*: If you are in a `no_std` environment, you have to
Copy link
Member

Choose a reason for hiding this comment

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

We could probably replace all the std:: uses with core:: - that is available for libstd users.

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.

2 participants