Minor edits on README.md #1645

pull Gudnessuche wants to merge 2 commits into bitcoin-core:master from Gudnessuche:patch-1 changing 1 files +9 −9

Gudnessuche commented at 3:30 AM on December 11, 2024: none

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.

Minor edits on README.md

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.

195d15debd

real-or-random added the label user-documentation on Dec 11, 2024
real-or-random added the label refactor/smell on Dec 11, 2024

in README.md:58 in 195d15debd outdated

  56 | @@ -57,7 +57,7 @@ Implementation details
  57 |    * Use a precomputed table of multiples of powers of 16 multiplied with the generator, so general multiplication becomes a series of additions.
  58 |    * Intended to be completely free of timing sidechannels for secret-key operations (on reasonable hardware/toolchains)

real-or-random commented at 9:02 AM on December 11, 2024:

What about this line? And I think there are further lines.

real-or-random commented at 9:03 AM on December 11, 2024: contributor

Perhaps it's easier to remove all periods in lists (except where a full sentence appears in a list item).
gatleas17 approved
Update README.md
fixed for all periods
5b69348c11
Gudnessuche commented at 4:03 PM on December 11, 2024: none

Fixed for all period
gatleas17 approved
in README.md:41 in 5b69348c11
```
  40 | -    * Using 5 52-bit limbs
  41 | +    * Using 5 52-bit limbs.
  42 |      * Using 10 26-bit limbs (including hand-optimized assembly for 32-bit ARM, by Wladimir J. van der Laan).
  43 |        * 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.
  44 | -* Scalar operations
  45 | +* Scalar operations.
```
jonasnick commented at 8:27 AM on December 17, 2024:

Agree with @real-or-random. Adding periods in places like this does not make much sense.

Gudnessuche commented at 2:14 PM on December 17, 2024:

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.

jonasnick commented at 9:50 PM on December 18, 2024:

Sorry, I don't get your comment. Closing this PR for now. Feel free to reopen if you have an updated suggestion.
gatleas17 approved
gatleas17 approved
bitcoin-core deleted a comment on Dec 18, 2024
jonasnick closed this on Dec 18, 2024

Contributors

Labels

user-documentation refactor/smell