1
0
mirror of https://github.com/lightning/bolts.git synced 2025-01-18 13:22:35 +01:00

update stylesheet checklist

fix stylesheet formatting; add passive voice item to stylesheet checklist; apply passive voice change to BOLT 1;
This commit is contained in:
Landon Mutch 2017-11-10 11:49:19 -08:00
parent b5d2d8b7a8
commit 4e70a8b607
2 changed files with 16 additions and 13 deletions

View File

@ -1,5 +1,5 @@
Basic checklist/stylesheet used for copy editing BOLTs.
Temporarily included here for reference purposes.
Basic checklist/stylesheet used for copy editing BOLTs,
temporarily included here for reference purposes.
- spelling
- typos
@ -7,6 +7,8 @@ Temporarily included here for reference purposes.
- sentence fragments
- run-on sentences
- dangling, misplaced modifiers
- consistent paragraph tense (e.g. past, present, future)
- passive voice (e.g. avoid 'we')
- capitalization
- table of contents
- headers
@ -26,19 +28,20 @@ Temporarily included here for reference purposes.
- comma before 'and' item
- period at branch ends
- example:
>A sending node:
- MAY do this.
- if this:
- SHOULD do this.
- else:
- MUST do this,
- and MUST NOT do this.
```
A sending node:
- MAY do this.
- if this:
- SHOULD do this.
- else:
- MUST do this,
- and MUST NOT do this.
```
- links
- broken links
- link text
- correct anchors/urls
- references
- e.g. <sup>[1](#reference-1)</sup>
- format e.g. <sup>[1](#reference-1)</sup>
- tags
- consistent usage, e.g. [TODO:], [FIXME:]

View File

@ -240,8 +240,8 @@ Connections between nodes within the network may be very long lived, as payment
channels have an indefinite lifetime. However, it's likely that for a
significant portion of the lifetime of a connection, no new data will be
exchanged. Also, on several platforms it's possible that Lightning
clients will be put to sleep without prior warning. Hence, we use a
distinct `ping` message, in order to probe for the liveness of the connection on
clients will be put to sleep without prior warning. Hence, a
distinct `ping` message is used, in order to probe for the liveness of the connection on
the other side, as well as to keep the established connection active.
Additionally, the ability for a sender to request that the receiver send a