-
Notifications
You must be signed in to change notification settings - Fork 55
Fix two typos in Readme.md #53
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
Conversation
Readme.md
Outdated
|
|
||
| bytes(1024); | ||
| // output: 1KB | ||
| // output: 1024 |
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 am getting 1KB as the output of bytes(1024) in the current module:
$ node -pe 'require("bytes")(1024)'
1KB
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.
Hi @dougwilson yes you're correct. This section of the documentation is about the parse method, though, so perhaps these examples should explicitly read bytes.parse(1024) instead?
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.
Ah, I see. It looks like when the parse/format were made available, the doc examples were not updated to match. It looks like there is likely a lot to accomplish there, would you be open to splitting that into a separate PR from the first typo? Likely needs to (1) document the bytes function itself with the examples there from both of the two existing sections to demonstrate it, (2) change the examples in format section to be bytes.format and (3) change examples in the parse section to be bytes.parse.
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.
Yes, I'd be happy to write that up. Will back out this change for this PR.
|
@dougwilson This hasn't been addressed in a little over a year. Are we safe to merge it? |
dougwilson
left a comment
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.
apologies i left this to linger.
Add quotes in example of
thousandsSeparator, and fix incorrect output ofbytes.parse(1024).