-
Notifications
You must be signed in to change notification settings - Fork 10
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
Clean up imports, fix doc lints, get doctests to pass #59
Conversation
There was a problem hiding this 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
Sounds good. I did make that change except for
This also needs a |
Is this still on 2015 edition? |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think we should move to 2018 edition, where using core gets much easier.
Updated to 2018 edition. I think I got everything obvious at least, it builds, clippy seems happy, and the tests pass... Give this a look and let me know :) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks much better than what we had before :)
Thanks!
Hmm, CI didn't pass. |
Oops, looks like I missed some feature combination. Let me get this fixed. |
Ah, looks like an unused import lint that was only there in when using the "from_str" feature. Should be fixed... hopefully now |
So, there was still a However, I noticed that the As this is already getting the codebase modernized, what do you think of pinning clippy to a newer version? currently CI pins it at Sorry for the mess with failed CI on this PR, I think I tested it all now locally and it should pass. |
No worries. CI is tricky and this crate is old. I wouldn't want to go newer than 1.76, which is the oldest supported Ferrocene (https://ferrous-systems.com/blog/ferrocene-24-05-0/). |
But let's do those updates in another PR. |
Clippy is currently pinned to
Should we pin clippy to |
Sounds like a good idea. |
Appreciate your help on this! |
Great, it passed :) Thanks for your patience, much appreciated! |
As discussed in #58, this cleans up the following:
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 inno_std
environments,use core as std
is required when using the macros.