Add defmt support and highlight crate features in docs.rs #70
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This adds support for defmt via the
defmt
feature flag. This mainly brings defmt to the error types, but also adds it toOrientation
.To improve documentation, I added a rustdoc conditional feature for highlighting gated feature. All of the
defmt::Format
implementations could have been simply derived with acfg_attr
, but it doesn't work smoothly with the#[cfg_attr(docsrs, doc(...))]
annotation.To test documentation, you can run:
RUSTDOCFLAGS='--cfg docsrs' cargo +nightly doc --open --all-features
It should render like this: