Add minimal examples demonstrating Formatters #600
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This change adds some doc tests to show off what the formatter looks like. This change adds it for just the byte variants: - `HumanBytes`, which seems to forward to `BinaryBytes`? - `DecimalBytes`, 1 MB == 1 * 10**6 bytes - `BinaryBytes`, 1 MiB == 1 * (1 << 20) bytes
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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 change adds some doc tests to show off what the formatter looks like. This change adds it for just the byte variants:
HumanBytes, which seems to forward toBinaryBytes?DecimalBytes, 1 MB == 1 * 10**6 bytesBinaryBytes, 1 MiB == 1 * (1 << 20) bytesI wanted to know what these formatters look like, preferably from the docs. This is the simplest way that comes to mind, but I'm open to doing this differently if there's alternatives. I only did the Byte variants with this. I'm happy to work on the others but want to make sure this direction is accepted first.
Here's what my local
rustdocdocs look like after this change:These also double as tests, and
cargo testwill fail if their behavior changes.