Join GitHub today
GitHub is home to over 28 million developers working together to host and review code, manage projects, and build software together.
Sign upReword millisecond docs to give example of usage #376
Conversation
This comment has been minimized.
Show comment
Hide comment
This comment has been minimized.
jvoigtlaender
Aug 28, 2015
Contributor
I don't really like the talk of "variable" here (in the new documentation comment). Does the core documentation use language like "variable" elsewhere?
Generally, wouldn't a much easier fix to the problematic aspect of the documentation you point out be to simply replace (500 * milliseconds) by (500 * millisecond)? Why is the rest of the rewording necessary from your perspective?
|
I don't really like the talk of "variable" here (in the new documentation comment). Does the Generally, wouldn't a much easier fix to the problematic aspect of the documentation you point out be to simply replace |
This comment has been minimized.
Show comment
Hide comment
This comment has been minimized.
eeue56
Aug 28, 2015
Contributor
I've removed the word variable now - I agree it didn't feel right there.
That would be an easier fix, but a less clear fix I feel. I wanted an explicit code example that people could use right away, rather an example just in the brackets, which doesn't seem as obvious that it's meant to be code. Adding halfSecond = 500 * millisecond makes it more explicit and obvious than (500 * millisecond) in the middle of a sentence, basically.
|
I've removed the word variable now - I agree it didn't feel right there. That would be an easier fix, but a less clear fix I feel. I wanted an explicit code example that people could use right away, rather an example just in the brackets, which doesn't seem as obvious that it's meant to be code. Adding |
This comment has been minimized.
Show comment
Hide comment
This comment has been minimized.
eeue56
Aug 28, 2015
Contributor
Though I could just change it to remove the s if you think that's clear enough.
|
Though I could just change it to remove the |
This comment has been minimized.
Show comment
Hide comment
This comment has been minimized.
|
I actually think just removing the plural |
This comment has been minimized.
Show comment
Hide comment
This comment has been minimized.
jvoigtlaender
Aug 29, 2015
Contributor
That it's code, should be clear from type-setting on the docs page.
|
That it's code, should be clear from type-setting on the docs page. |
eeue56
closed this
Aug 29, 2015
eeue56
reopened this
Aug 29, 2015
This comment has been minimized.
Show comment
Hide comment
This comment has been minimized.
eeue56
Aug 29, 2015
Contributor
Okay - changed it so it's now just the 's' removal, and got rid of the previous commits I made too.
|
Okay - changed it so it's now just the 's' removal, and got rid of the previous commits I made too. |
eeue56 commentedAug 28, 2015
As per #373, makes millisecond docs simpler to understand