2
0
mirror of https://github.com/lnbook/lnbook synced 2024-11-01 03:20:53 +00:00
Commit Graph

100 Commits

Author SHA1 Message Date
8go
1c3f3d7f52
minor improvements to chapter "Examining the bad way" (#193)
- simplified
- reduced sentence length
- comma after thus
- with respect to time "immediately" is better than "directly"
- avoid extremes, replaced "much higher" with "higher", later we specify the figure 5x anyway
- "additional" better than "more" 
- misc clarifications
- some additions
- etc
2020-04-22 18:51:56 +02:00
8go
a7f830d7f1
minor improvements to chapter "Examining the good way - mutual close" (#192)
- closing tx, shutdown tx, etc:  to avoid any confusion I took the "shutdown tx" out and simply named it the "on-chain tx"
- replaced "party" with "channel partner" for consistency
- removed "as many people think". If the book does a good job, not many people will think that ! In any case, this phrase does not help. Better to just state the facts. 
- etc
2020-04-22 18:49:59 +02:00
8go
ee3164c398
minor improvements to chapter "Closing the channel" (#191)
- Bitcoin: uppercase as it refers to fees on the Bitcoin protocol
- added more detail on importance of longevity of channel
- the last sentence was way too long and too complicated. restructured it.
- etc
2020-04-22 18:48:45 +02:00
8go
66f730a077
minor improvements to "Announcing the channel" (#190)
- added distinction between "public" and "private" channel, added the 2 terms
- rename 2-2 to 2-out-of-2 for consistency and to make it clearer
- simplified a few sentences
- added a few additional clarifying words
- etc
2020-04-22 18:45:41 +02:00
8go
97c8927d66
improvements to chapter "Commitment Transaction", part 2 (#189)
- comma after however
- when referring to time "immediately" is better and more meaningful than "directly"
- when referring to time duration "lasts" is better than "is"
- consistency: "channel partner" better than "party"
- etc
2020-04-22 18:40:14 +02:00
8go
05f8370259
Improvements to chapter "Commitment Transaction" (#188)
- replace "capacity" with "funds to reduce tech jargon
- replaced 2-2 with 2-out-of-2 for consistency and to clarify
- everyone --> singular  .. its funds .. not their funds
- "wallet" wrong, "address" better
- avoid "flaw", it might get misinterpreted, rephrased to clearly state that we present the design step-by-step
- "you probably have realized" and "hope you recognize that" puts the reader in a bind. If the reader does not see the problem we will feel "dumb" because the text implies "probably you realized". I suggest to rewrite it so, that the reader does not feel "dumb" just because he does not see the shortcut. --> see changes
- however requires comma
- avoid extremes like "rather high", use facts and measurable units, here simply "high"
- "to lose funds" incorrect, "loose" is correct
- took one long sentence and split it up into several short one making understanding a lot simpler
- etc
2020-04-22 18:38:13 +02:00
8go
5b3a4ab256
minor improvements to chapter "Payment Hash" and "Additional Meta Data" (#198)
- repeated use of "also", --> furthermore, ...
- minor clarifications
- etc
2020-04-22 18:25:25 +02:00
8go
114387e822
minor improvements to chapter "Delivering the payment" (#199)
- peer-to-peer better than "peer 2 peer" , in acronyms p2p is ok
- English language guidelines recommend numbers up to 12 to be spelled out. 4 --> four
- minor additions/clarifications
2020-04-22 18:22:24 +02:00
8go
e2aaeca0df
minor improvements to chapter "Finding a path" (#200)
- added commas
- some sentences presented the ideas in the wrong order and the sentences were too long --> restructured sentences
- etc
2020-04-22 18:19:51 +02:00
8go
e7fd91964b
minor improvements to chapter "Missing bits" (#202)
- repeated use of "following"
- peer-to-peer instead "peer to peer"
- minor clarifications
- etc
2020-04-22 18:12:29 +02:00
Kory Newton
f226a5fb1a
fix typos in chapter 3 (#166)
* fix typos Chapter 3

* additional ch3 typo fixes

Co-authored-by: Rene Pickhardt <rene@rene-pickhardt.de>
2020-04-18 10:57:17 +02:00
Roman
ae9d905f27
fix typos in ch1 and ch2 (#168)
* table indentation

* 'a' before consonant

* less commas

* wording

* unquote commas

* typo

* on chain -> on-chain

* need comma (IMHO)

* dot

* caps acronym

* wording

Co-authored-by: Rene Pickhardt <rene@rene-pickhardt.de>
2020-04-18 10:54:47 +02:00
8go
e7ea91fe81
minor improvements in "Example of a poor channel opening procedure" (#184)
- replace "committing attack" with "performing attack" to avoid that the reader incorrectly concludes that the term "commitment tx" has anything to do with "committing an attack"
- signed by, not signed from
2020-04-18 10:51:19 +02:00
8go
58f282ee38
minor improvements to Funding Transaction paragraphs (#183)
- consistently sticking to "2-out-of-2"
- rephrasing some sentences to make them more palatable. "obviously a lie" is a bit aggressive. 
- avoid using exaggerating terms like "very expensive", just state the facts without too many emotions
2020-04-18 10:50:33 +02:00
8go
a4e59ed614
improvements to Multisig addresses paragraphs (#182)
- as before "2-out-of-2" is more appropriate than "2-2" 
- "thus" is not what you wanted to express, "however" is what you wanted to say
- added missing comma
- etc
2020-04-18 10:49:06 +02:00
8go
26b0fb4e78
minor corrections in Payment channels paragraphs (#181)
- "the both of you": incorrect English, better "both of you"
- "cheat on you": spoken English, better "cheat you"
- "had to be", that sounds like you are guessing, better "was"
- if you give full names of some, give full names of all 
- added year to make it more precise
- etc.
2020-04-18 10:48:10 +02:00
8go
bf44a80973
minor improvements, corrections (#180)
- comma must follow "additionally" and "however" as they are introductory words or phrases
- same for "last but not least", comma missing
- "nothing else than", not perfect English; better "nothing but" 
- "get most use", not perfect English; better "get more benefits"
2020-04-18 10:45:20 +02:00
8go
a80f758b1f
minor improvements in Note (#179)
- 2-out-of-2 is more consistent (see usage above) and carries more information than 2-2
- comma after however needed
2020-04-18 10:44:16 +02:00
8go
b4204ba4cf
added a few words to improve definition paragraph (#178)
- consistent use of "partner"
- added "Bitcoin" to "Bitcoin smart contract" because there are many people out there that have heard the term "smart contract" exclusively in the context of Ethereum. It might be worth while to underline that Bitcoin also has its form of smart contracts. This should eliminate any possible doubts.
- imply that earlier states are no longer valid, added "invalidated" 
- channel member is singular, so "if they try" is wrong. better "if it tries"
2020-04-18 10:43:44 +02:00
8go
52aa362dcc
improved definition of LN (#177)
- removed incorrect comma in front of "as well as"
- added "both" to make it stronger that LN has 2 main functionalities
- "... on the network." leaves it undefined. The reader might ask to which netowrk it refers to? To the before mentioned netowrk of payment-channels? Added "Bitcoin" to clarify.
2020-04-18 10:42:52 +02:00
Patrick Lemke
68911c5560 remove end of line spaces 2020-02-23 19:21:01 +01:00
Patrick Lemke
c97ad6e980 capitalization 2020-02-23 19:16:07 +01:00
Patrick Lemke
4fe03c9567 capitalization 2020-02-23 19:16:07 +01:00
Patrick Lemke
0076c89e35 capitalization 2020-02-23 19:16:07 +01:00
Patrick Lemke
76079a3d6d wording 2020-02-23 19:16:07 +01:00
Patrick Lemke
9df3a8267a typo 2020-02-23 19:16:07 +01:00
Patrick Lemke
2c8860b00e typo 2020-02-23 19:16:07 +01:00
Patrick Lemke
18fbeb85d2 comma separation 2020-02-23 19:14:42 +01:00
Patrick Lemke
cf94641c26 wording 2020-02-23 19:13:44 +01:00
Patrick Lemke
bd79255000 spacing 2020-02-23 19:11:31 +01:00
Patrick Lemke
85f5e4de32 comma separation 2020-02-23 19:09:56 +01:00
Patrick Lemke
f7df2f5cd3 capitalization 2020-02-23 19:00:43 +01:00
Patrick Lemke
56dfd77201 capitalization 2020-02-23 19:00:43 +01:00
Patrick Lemke
0af20a81dd typo 2020-02-23 18:59:56 +01:00
Patrick Lemke
6091c64296 typo 2020-02-23 18:59:27 +01:00
Patrick Lemke
df0a164f77 typo 2020-02-23 18:59:27 +01:00
Patrick Lemke
0724f00353 capitalization 2020-02-23 18:59:27 +01:00
Patrick Lemke
0e8c264ed0 capitalization 2020-02-23 18:58:47 +01:00
Patrick Lemke
7375e64c0d capitalization 2020-02-23 18:58:06 +01:00
Patrick Lemke
64520e1d4f capitalization 2020-02-23 18:56:53 +01:00
Patrick Lemke
43c398e790 comma seperation 2020-02-23 18:55:46 +01:00
Patrick Lemke
dca5f71310 wording 2020-02-23 18:54:51 +01:00
Patrick Lemke
34d2907f3f word order 2020-02-23 18:53:07 +01:00
Patrick Lemke
a694e7038a word order, wording 2020-02-23 18:53:07 +01:00
Patrick Lemke
c8cf9a0de0 capitalization 2020-02-23 18:52:38 +01:00
Patrick Lemke
7d461fc30a wording 2020-02-23 18:52:38 +01:00
Patrick Lemke
f0fd10b6ee wording 2020-02-23 18:52:38 +01:00
Patrick Lemke
459939daed wording 2020-02-23 18:52:38 +01:00
Patrick Lemke
b0935fdb42 wording 2020-02-23 18:52:38 +01:00
Patrick Lemke
e7a760c1b9 wording, pronouns 2020-02-23 18:52:38 +01:00