BREAKING(fmt/bytes): rename prettyBytes to format #2896
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
cjihrig
reviewed
Nov 16, 2022
fmt/bytes.ts
Outdated
| @@ -17,7 +17,7 @@ type LocaleOptions = { | |||
| }; | |||
|
|
|||
| /** | |||
| * The options for pretty printing the byte numbers. | |||
| * @depreacted (will be removed after 0.170.0) use `FormatOptions` instead | |||
There was a problem hiding this comment.
This is spelled incorrectly in a few places:
Suggested change
| * @depreacted (will be removed after 0.170.0) use `FormatOptions` instead | |
| * @deprecated (will be removed after 0.170.0) use `FormatOptions` instead |
|
The rename seems like a good idea to me. Consistency is best |
kt3k
changed the title
|
The renaming would make the |
|
I'm now slightly in favor of this change as 'format' sounds like a more appropriate name for standard modules than 'prettyBytes'. |
cjihrig
approved these changes
Nov 18, 2022
|
+1 on the name change, feels a lot more "standard module" and it has the bonus of being closer to web naming specs. |
|
Looks like we are all supportive to this. @timreichen Thanks for your suggestion! |
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.
prettyBytestoformatprettyBytesPrettyBytesOptionstoFormatOptionsPrettyBytesOptionsThis is a change in an effort to have the two std formatting mods
fmt/bytesandfmt/duration(#2871) have similar naming schemes inspired by existing web apis (https://github.com/tc39/proposal-intl-duration-format).