Skip to content

Commit e6dca0c

Browse files
committed
multi: Fix typos and grammar in multiple docs
1 parent 71ba355 commit e6dca0c

29 files changed

+81
-81
lines changed

.github/pull_request_template.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,6 @@ Steps for reviewers to follow to test the change.
1515
- [ ] Commits follow the [Ideal Git Commit Structure](https://github.com/lightningnetwork/lnd/blob/master/docs/code_contribution_guidelines.md#IdealGitCommitStructure).
1616
- [ ] Any new logging statements use an appropriate subsystem and logging level.
1717
- [ ] Any new lncli commands have appropriate tags in the comments for the rpc in the proto file.
18-
- [ ] [There is a change description in the release notes](https://github.com/lightningnetwork/lnd/tree/master/docs/release-notes), or `[skip ci]` in the commit message for small changes.
18+
- [ ] [There is a change description in the release notes](https://github.com/lightningnetwork/lnd/tree/master/docs/release-notes), or `[skip ci]` in the commit message for small changes.
1919

20-
📝 Please see our [Contribution Guidelines](https://github.com/lightningnetwork/lnd/blob/master/docs/code_contribution_guidelines.md) for further guidance.
20+
📝 Please see our [Contribution Guidelines](https://github.com/lightningnetwork/lnd/blob/master/docs/code_contribution_guidelines.md) for further guidance.

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ said, the current status of `lnd`'s BOLT compliance is:
5151
The daemon has been designed to be as developer friendly as possible in order
5252
to facilitate application development on top of `lnd`. Two primary RPC
5353
interfaces are exported: an HTTP REST API, and a [gRPC](https://grpc.io/)
54-
service. The exported API's are not yet stable, so be warned: they may change
54+
service. The exported APIs are not yet stable, so be warned: they may change
5555
drastically in the near future.
5656

5757
An automatically generated set of documentation for the RPC APIs can be found

aezeed/README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ process. A lack of a birthday means that wallets don’t know how far
1111
back to look in the chain to ensure that they derive all the proper
1212
user addresses. Additionally, BIP39 use a very weak [KDF](https://en.wikipedia.org/wiki/Key_derivation_function). We use
1313
scrypt with modern parameters (n=32768, r=8, p=1). A set of benchmarks has
14-
been added, on my laptop I get about 100ms per attempt):
14+
been added, on my laptop I get about 100ms per attempt:
1515

1616
```shell
1717
$ go test -run=XXX -bench=.
@@ -48,13 +48,13 @@ the keys of the wallet.
4848

4949
The 2 byte timestamp is expressed in Bitcoin Days Genesis, meaning that
5050
the number of days since the timestamp in Bitcoin’s genesis block. This
51-
allow us to save space, and also avoid using a wasteful level of
51+
allows us to save space, and also avoid using a wasteful level of
5252
granularity. This can currently express time up until 2188.
5353

5454
Finally, the entropy is raw entropy that should be used to derive the
5555
wallet’s HD root.
5656

57-
## aezeed enciphering/deciperhing
57+
## aezeed enciphering/deciphering
5858

5959
Next, we’ll take the plaintext seed described above and encipher it to
6060
procure a final cipher text. We’ll then take this cipher text (the

docker/README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -217,7 +217,7 @@ bob $ lncli --network=simnet channelbalance
217217
```
218218

219219
Now we have open channel in which we sent only one payment, let's imagine
220-
that we sent lots of them and we'd now like to close the channel. Let's do
220+
that we sent lots of them, and we'd now like to close the channel. Let's do
221221
it!
222222
```shell
223223
# List the "Alice" channel and retrieve "channel_point" which represents
@@ -300,7 +300,7 @@ bitcoins. The schema will be following:
300300
to "Faucet" then the already created "btcd" node would be sufficient.
301301
```
302302

303-
First of all you need to run `btcd` node in `testnet` and wait for it to be
303+
First you need to run `btcd` node in `testnet` and wait for it to be
304304
synced with test network (`May the Force and Patience be with you`).
305305
```shell
306306
# Init bitcoin network env variable:
@@ -330,11 +330,11 @@ and send some amount of bitcoins to `Alice`.
330330
### Building standalone docker images
331331

332332
Instructions on how to build standalone docker images (for development or
333-
production), outside of `docker-compose`, see the
333+
production), outside `docker-compose`, see the
334334
[docker docs](../docs/DOCKER.md).
335335

336336
### Using bitcoind version
337-
If you are using the bitcoind version of the compose file i.e `docker-compose-bitcoind.yml`, follow these additional instructions:
337+
If you are using the bitcoind version of the compose file i.e. `docker-compose-bitcoind.yml`, follow these additional instructions:
338338

339339
#### Start Bitcoin Node with bitcoind using Docker Compose
340340
To launch the Bitcoin node using bitcoind in the regtest network using Docker Compose, use the following command:

docs/DOCKER.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,8 @@
33
There are two flavors of Dockerfiles available:
44
- `Dockerfile`: Used for production builds. Checks out the source code from
55
GitHub during build. The build argument `--build-arg checkout=v0.x.x-beta`
6-
can be used to specify what git tag or commit to check out before building.
6+
can be used to specify what git tag or commit to `git checkout`
7+
before building.
78
- `dev.Dockerfile` Used for development or testing builds. Uses the local code
89
when building and allows local changes to be tested more easily.
910

@@ -32,7 +33,7 @@ You first need to build the `lnd` docker image:
3233
$ docker build --tag=myrepository/lnd --build-arg checkout=v0.14.1-beta .
3334
```
3435

35-
It is recommended that you checkout the latest released tag.
36+
It is recommended that you check out the latest released tag.
3637

3738
You can continue by creating and running the container:
3839

docs/INSTALL.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ are released by the team. See
3939
[release.md for more information about reproducible builds](release.md).
4040

4141
Finally, there is the option to build `lnd` fully manually. This requires more
42-
tooling to be set up first but allows to produce non-production (debug,
42+
tooling to be set up first but allows producing non-production (debug,
4343
development) builds.
4444

4545
## Installing a binary release
@@ -136,7 +136,7 @@ the following commands for your OS:
136136
<details>
137137
<summary>macOS</summary>
138138

139-
First, install [Homebrew](https://brew.sh) if you dont already have it.
139+
First, install [Homebrew](https://brew.sh) if you don't already have it.
140140

141141
Then
142142

@@ -205,7 +205,7 @@ make install
205205

206206
The command above will install the current _master_ branch of `lnd`. If you
207207
wish to install a tagged release of `lnd` (as the master branch can at times be
208-
unstable), then [visit then release page to locate the latest
208+
unstable), then [visit the release page to locate the latest
209209
release](https://github.com/lightningnetwork/lnd/releases). Assuming the name
210210
of the release is `v0.x.x`, then you can compile this release from source with
211211
a small modification to the above command:
@@ -294,7 +294,7 @@ To check that `lnd` was installed properly run the following command:
294294
```
295295

296296
This command requires `bitcoind` (almost any version should do) to be available
297-
in the system's `$PATH` variable. Otherwise some of the tests will fail.
297+
in the system's `$PATH` variable. Otherwise, some tests will fail.
298298

299299
**Command-line completion for `lncli`**
300300

@@ -308,7 +308,7 @@ time of writing of this document, there are three available chain backends:
308308
`btcd`, `neutrino`, `bitcoind`. All including neutrino can run on mainnet with
309309
an out of the box `lnd` instance. We don't require `--txindex` when running
310310
with `bitcoind` or `btcd` but activating the `txindex` will generally make
311-
`lnd` run faster. Note that since version 0.13 pruned nodes are supported
311+
`lnd` run faster. Note that since version 0.13 pruned nodes are supported,
312312
although they cause performance penalty and higher network usage.
313313

314314
The set of arguments for each of the backend modes is as follows:
@@ -461,7 +461,7 @@ the following:
461461
- Make sure the config setting `-rpcserialversion` in `bitcoind` is either set
462462
to 1 or NOT used because bitcoind's default behaviour is already correct
463463
(see [bitcoin/issues/28730](https://github.com/bitcoin/bitcoin/issues/28730)
464-
for more infos). Lightning depends on segwit transactions therefore we need
464+
for more info). Lightning depends on segwit transactions therefore we need
465465
the witness data when querying the bitcoind backend for transaction details.
466466

467467
- Start `bitcoind` running against testnet, and let it complete a full sync with
@@ -541,7 +541,7 @@ document](wallet.md).
541541
`lnd`'s authentication system is called **macaroons**, which are decentralized
542542
bearer credentials allowing for delegation, attenuation, and other cool
543543
features. You can learn more about them in Alex Akselrod's [writeup on
544-
Github](https://github.com/lightningnetwork/lnd/issues/20).
544+
GitHub](https://github.com/lightningnetwork/lnd/issues/20).
545545

546546
Running `lncli create` to create a wallet, will by default generate
547547
the `admin.macaroon`, `read_only.macaroon`, and `macaroons.db`
@@ -596,7 +596,7 @@ Optionally, if you'd like to have a persistent configuration between `lnd`
596596
launches, allowing you to simply type `lnd --bitcoin.testnet --bitcoin.active`
597597
at the command line, you can create an `lnd.conf`.
598598

599-
**On MacOS, located at:**
599+
**On macOS, located at:**
600600
`/Users/<username>/Library/Application Support/Lnd/lnd.conf`
601601

602602
**On Linux, located at:**

docs/MAKEFILE.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ $ make install
1010
```
1111

1212
The command `make check` requires `bitcoind` (almost any version should do) to
13-
be available in the system's `$PATH` variable. Otherwise some of the tests will
13+
be available in the system's `$PATH` variable. Otherwise, some tests will
1414
fail.
1515

1616
Developers

docs/code_contribution_guidelines.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ not hard requirements as we will gladly accept code contributions as long as
5656
they follow the guidelines set forth on this page. That said, if you don't have
5757
the following basic qualifications you will likely find it quite difficult to
5858
contribute to the core layers of Lightning. However, there are still a number
59-
of low hanging fruit which can be tackled without having full competency in the
59+
of low-hanging fruit which can be tackled without having full competency in the
6060
areas mentioned below.
6161

6262
- A reasonable understanding of bitcoin at a high level (see the
@@ -82,7 +82,7 @@ security and performance implications.
8282
it must follow the guidelines therein.
8383
- [Original Satoshi Whitepaper](https://bitcoin.org/bitcoin.pdf) - This is the white paper that started it all. Having a solid
8484
foundation to build on will make the code much more comprehensible.
85-
- [Lightning Network Whitepaper](https://lightning.network/lightning-network-paper.pdf) - This is the white paper that kicked off the Layer 2 revolution. Having a good grasp of the concepts of Lightning will make the core logic within the daemon much more comprehensible: Bitcoin Script, off-chain blockchain protocols, payment channels, bi-directional payment channels, relative and absolute time-locks, commitment state revocations, and Segregated Witness.
85+
- [Lightning Network Whitepaper](https://lightning.network/lightning-network-paper.pdf) - This is the white paper that kicked off the Layer 2 revolution. Having a good grasp of the concepts of Lightning will make the core logic within the daemon much more comprehensible: Bitcoin Script, off-chain blockchain protocols, payment channels, bidirectional payment channels, relative and absolute time-locks, commitment state revocations, and Segregated Witness.
8686
- The original LN was written for a rather narrow audience, the paper may be a bit unapproachable to many. Thanks to the Bitcoin community, there exist many easily accessible supplemental resources which can help one see how all the pieces fit together from double-spend protection all the way up to commitment state transitions and Hash Time Locked Contracts (HTLCs):
8787
- [Lightning Network Summary](https://lightning.network/lightning-network-summary.pdf)
8888
- [Understanding the Lightning Network 3-Part series](https://bitcoinmagazine.com/articles/understanding-the-lightning-network-part-building-a-bidirectional-payment-channel-1464710791)
@@ -101,7 +101,7 @@ be recommended for newcomers to read first in order to get up to speed.
101101
# Development Practices
102102

103103
Developers are expected to work in their own trees and submit pull requests when
104-
they feel their feature or bug fix is ready for integration into the master
104+
they feel their feature or bug fix is ready for integration into the master
105105
branch.
106106

107107
## Share Early, Share Often
@@ -478,7 +478,7 @@ also likely be asked to split the commit into several smaller, and hence more
478478
manageable, commits.
479479
480480
Keeping the above in mind, most small changes will be reviewed within a few
481-
days, while large or far reaching changes may take weeks. This is a good reason
481+
days, while large or far-reaching changes may take weeks. This is a good reason
482482
to stick with the [Share Early, Share Often](#share-early-share-often)
483483
development practice outlined above.
484484
@@ -506,7 +506,7 @@ make the necessary changes.
506506
507507
During the process of responding to review comments, we prefer that changes be
508508
made with [fixup commits](https://robots.thoughtbot.com/autosquashing-git-commits).
509-
The reason for this is two fold: it makes it easier for the reviewer to see
509+
The reason for this is twofold: it makes it easier for the reviewer to see
510510
what changes have been made between versions (since Github doesn't easily show
511511
prior versions like Critique) and it makes it easier on the PR author as they
512512
can set it to auto squash the fix up commits on rebase.
@@ -552,7 +552,7 @@ also ping them to remind them to re-request review if needed. (default x = 3)
552552
To control the bot, you need to add a comment on the PR starting with
553553
`!lightninglabs-deploy` followed by the command. There are 2 control types:
554554
mute/unmute & cadence. Only the latest comment for each control type will be
555-
used. This also means you dont need to keep adding new control comments, just
555+
used. This also means you don't need to keep adding new control comments, just
556556
edit the latest comment for that control type.
557557
558558
- `!lightninglabs-deploy mute` will mute the bot on the PR completely.

docs/code_formatting_rules.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -180,8 +180,8 @@ like `require.NoErrorf()`.
180180

181181
### Wrapping long function definitions
182182

183-
If one is forced to wrap lines of function arguments that exceed the 80
184-
character limit, then indentation must be kept on the following lines. Also,
183+
If one is forced to wrap lines of function arguments that exceed the
184+
80-character limit, then indentation must be kept on the following lines. Also,
185185
lines should not end with an open parenthesis if the function definition isn't
186186
finished yet.
187187

@@ -241,7 +241,7 @@ support the `EditorConfig` scheme (for example GoLand, GitHub, GitLab,
241241
VisualStudio). In addition, specific settings for Visual Studio Code are checked
242242
into the code base as well.
243243
244-
Other editors (for example Atom, Nodepad++, Vim, Emacs and so on) might install
244+
Other editors (for example Atom, Notepad++, Vim, Emacs and so on) might install
245245
a plugin to understand the rules in the `.editorconfig` file.
246246
247-
In Vim you might want to use `set colorcolumn=80`.
247+
In Vim, you might want to use `set colorcolumn=80`.

docs/configuring_tor.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -86,8 +86,8 @@ Tor:
8686
--tor.privatekeypath= The path to the private key of the onion service being created
8787
```
8888
89-
There are a couple things here, so let's dissect them. The `--tor.active` flag
90-
allows `lnd` to route all outbound and inbound connections through Tor.
89+
There are a couple of things here, so let's dissect them. The `--tor.active`
90+
flag allows `lnd` to route all outbound and inbound connections through Tor.
9191
9292
Outbound connections are possible with the use of the `--tor.socks` and
9393
`--tor.dns` arguments. The `--tor.socks` argument should point to the interface
@@ -125,7 +125,7 @@ disabled to prevent inadvertent leaks.
125125
## Tor Stream Isolation
126126

127127
Our support for Tor also has an additional privacy enhancing modified: stream
128-
isolation. Usage of this mode means that Tor will always use _new circuit_ for
128+
isolation. Usage of this mode means that Tor will always use _new circuit_ for
129129
each connection. This added features means that it's harder to correlate
130130
connections. As otherwise, several applications using Tor might share the same
131131
circuit.
@@ -160,7 +160,7 @@ authentication methods (arguably, from most to least secure):
160160

161161
In order to listen for inbound connections through Tor, an onion service must be
162162
created. There are two types of onion services: v2 and v3. v3 onion services
163-
are the latest generation of onion services and they provide a number of
163+
are the latest generation of onion services, and they provide a number of
164164
advantages over the legacy v2 onion services. To learn more about these
165165
benefits, see [Intro to Next Gen Onion Services](https://trac.torproject.org/projects/tor/wiki/doc/NextGenOnions).
166166

0 commit comments

Comments
 (0)