FilterType: Add examples and timings to docs #1040
Merged
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.
Preview:
Unfortunately Rustdoc does not provide a simple method to include images in the docs (see rust-lang/rust#32104). I quickly considered including them as inline base64, but that would add a huge amount of text to the enum documentation. Instead, I linked to them from GitHub.
This means that when doing local changes, these need to be previewed by manually replacing the github URL with a relative link (
../../../docs/
). However, it should work on docs.rs.I license past and future contributions under the dual MIT/Apache-2.0 license,
allowing licensees to chose either at their option.