-
Notifications
You must be signed in to change notification settings - Fork 1k
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
Minor edits on README.md #1645
Minor edits on README.md #1645
Conversation
Be consistent in ending every sentence with a period (especially outside a parenthesis as in L16). It keeps the document as perfectly professional as possible.
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.
Perhaps it's easier to remove all periods in lists (except where a full sentence appears in a list item).
README.md
Outdated
@@ -57,7 +57,7 @@ Implementation details | |||
* Use a precomputed table of multiples of powers of 16 multiplied with the generator, so general multiplication becomes a series of additions. | |||
* Intended to be completely free of timing sidechannels for secret-key operations (on reasonable hardware/toolchains) |
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.
What about this line? And I think there are further lines.
fixed for all periods
Fixed for all period |
* Using 10 26-bit limbs (including hand-optimized assembly for 32-bit ARM, by Wladimir J. van der Laan). | ||
* This is an experimental feature that has not received enough scrutiny to satisfy the standard of quality of this library but is made available for testing and review by the community. | ||
* Scalar operations | ||
* Scalar operations. |
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.
Agree with @real-or-random. Adding periods in places like this does not make much sense.
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.
While you're 100% correct that there might not be technical merit in these miniscule changes, it just irked me a little bit, that the words that described the technicals, weren't 100% punctuated, and as a grammar expert, I felt compelled to do the needful, for other grammarians in the future who'd probably come across this document.
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.
Sorry, I don't get your comment. Closing this PR for now. Feel free to reopen if you have an updated suggestion.
Be consistent in ending every sentence with a period (especially outside a parenthesis as in L16).
It keeps the document as perfectly professional as possible.