Fix various typos in docs for readability #8881

mwaite-codes · 2024-07-01T04:56:53Z

Change Description

A small set of trivial fixes for typos and readability in the docs.

Steps to Test

N/A

Pull Request Checklist

Testing

[Y] Your PR passes all CI checks.
[N/A] Tests covering the positive and negative (error paths) are included.
[N/A] Bug fixes contain tests triggering the bug to prevent regressions.

Code Style and Documentation

[Y] The change obeys the Code Documentation and Commenting guidelines, and lines wrap at 80.
[Y] Commits follow the Ideal Git Commit Structure.
[Y] Any new logging statements use an appropriate subsystem and logging level.
[N/A] Any new lncli commands have appropriate tags in the comments for the rpc in the proto file.
[N/A] There is a change description in the release notes, or [skip ci] in the commit message for small changes.

📝 Please see our Contribution Guidelines for further guidance.

coderabbitai · 2024-07-01T04:57:06Z

Important

Review skipped

Auto reviews are limited to specific labels.

Labels to auto review (1)

llm-review

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share

Tips

Chat

There are 3 ways to chat with CodeRabbit:

Review comments: Directly reply to a review comment made by CodeRabbit. Example:
- I pushed a fix in commit <commit_id>.
- Generate unit testing code for this file.
- Open a follow-up GitHub issue for this discussion.
Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
- @coderabbitai generate unit testing code for this file.
- @coderabbitai modularize this function.
PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
- @coderabbitai generate interesting stats about this repository and render them as a table.
- @coderabbitai show all the console.log statements in this repository.
- @coderabbitai read src/utils.ts and generate unit testing code.
- @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
- @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

@coderabbitai pause to pause the reviews on a PR.
@coderabbitai resume to resume the paused reviews.
@coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
@coderabbitai full review to do a full review from scratch and review all the files again.
@coderabbitai summary to regenerate the summary of the PR.
@coderabbitai resolve resolve all the CodeRabbit review comments.
@coderabbitai configuration to show the current CodeRabbit configuration for the repository.
@coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configuration File (`.coderabbit.yaml`)

You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
Please see the configuration documentation for more information.
If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

Visit our Documentation for detailed information on how to use CodeRabbit.
Join our Discord Community to get help, request features, and share feedback.
Follow us on X/Twitter for updates and announcements.

ellemouton

Thanks for the diff!

My main comment is about not changing the "an lnd" and an "lncli" lines since those are correct. See the rule about using "an" vs "a" for acronyms here)

ellemouton · 2024-07-01T07:32:40Z

docs/safety.md

@@ -411,7 +410,7 @@ node and the new Tor node:

 ### Prevent data corruption

-Many problems while running an `lnd` node can be prevented by avoiding data
+Many problems while running a `lnd` node can be prevented by avoiding data


since "LND" starts with a vowel sound ("el"), an is actually correct here. Same for the other spots and for the "lncli" spots

It does indeed. Fixed.

ellemouton · 2024-07-01T07:33:34Z

docs/safety.md

@@ -275,7 +275,7 @@ Other ways of obtaining SCBs for a node's channels are

 Because the backup file is encrypted with a key from the seed the node was
 created with, it can safely be stored on a cloud storage or any other storage
-medium. Many consumer focused wallet smartphone apps automatically store a
+medium. Many consumers focused wallet smartphone apps automatically store a


this was correct as it was "consumer focused wallet smartphone apps"

Good point. I corrected it.

ellemouton · 2024-07-01T07:34:41Z

docs/safety.md

  please see the [node migration section](#migrating-a-node-to-a-new-device).
 * For more technical information [see the aezeed README](../aezeed/README.md).

 ### Wallet password

 The wallet password is one of the first things that has to be entered if a new
-wallet is created using `lnd`. It is completely independent from the `aezeed`
+wallet is created using `lnd`. It is completely independent of the `aezeed`


imo it sounded ok before

I can see how that works. Fixed!

ellemouton · 2024-07-01T07:37:52Z

docs/code_formatting_rules.md

@@ -180,8 +180,7 @@ like `require.NoErrorf()`.

 ### Wrapping long function definitions

-If one is forced to wrap lines of function arguments that exceed the 80
-character limit, then indentation must be kept on the following lines. Also,
+If one is forced to wrap lines of function arguments that exceed the 80-character limit, then indentation must be kept on the following lines. Also,


hmmm unfortunately this change breaks the rule being noted 🤔 we want to keep the 80-char wrapping for now

ellemouton · 2024-07-01T07:38:22Z

docs/INSTALL.md

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


Wrapped in latest update.

ellemouton · 2024-07-01T07:38:45Z

docs/INSTALL.md

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

 The command above will install the current _master_ branch of `lnd`. If you
 wish to install a tagged release of `lnd` (as the master branch can at times be
-unstable), then [visit then release page to locate the latest
+unstable), then [visit release page to locate the latest


visit the release page

yyforyongyu

Thanks for the PR. Please check the contribution guidelines regarding Ideal Git Commit Structure.

mwaite-codes · 2024-07-07T20:15:53Z

Thanks for the PR. Please check the contribution guidelines regarding Ideal Git Commit Structure.

Would appreciate another look at this PR. :)

yyforyongyu

In the case of changes that touch several packages, and can only compile with the change across several packages, a multi: prefix should be used.

Also could you remove the skip CI flag? Thanks.

yyforyongyu · 2024-07-08T13:52:26Z

docs/INSTALL.md

@@ -478,7 +478,7 @@ zmqpubrawtx=tcp://127.0.0.1:28333

 Once all of the above is complete, and you've confirmed `bitcoind` is fully
 updated with the latest blocks on testnet, run the command below to launch
-`lnd` with `bitcoind` as your backend (as with `bitcoind`, you can create an
+`lnd` with `bitcoind` as your backend (as with `bitcoind`, you can create a


If I understand English correctly I believe this should be an an.

unaddressed

yyforyongyu · 2024-07-08T13:52:42Z

docs/INSTALL.md

@@ -590,13 +590,13 @@ password stretching for the wallet encryption and therefore starts up faster
 than a production/mainnet/release build. The binary can be built by running
 `make build-itest`.

-# Creating an lnd.conf (Optional)
+# Creating a lnd.conf (Optional)


same here, and all the other places

bitromortac · 2024-07-08T16:20:37Z

docs/INSTALL.md

@@ -136,7 +136,7 @@ the following commands for your OS:
 <details>
  <summary>macOS</summary>

-  First, install [Homebrew](https://brew.sh) if you don‘t already have it.
+  First, install [Homebrew](https://brew.sh) if you don’t already have it.


nit: just stumbled over this, in the other place you used don't, here don’t, where don't is correct, I think

mwaite-codes · 2024-07-13T19:09:29Z

@yyforyongyu @bitromortac Requesting another look since the most recent change.

ellemouton

Still a couple of left over "an"-> "a" changes that should be un-done 🙏

docs/INSTALL.md

docs/configuring_tor.md

docs/grpc/java.md

docs/safety.md

ellemouton

almost there

ellemouton · 2024-07-16T12:41:34Z

docs/INSTALL.md

@@ -478,7 +478,7 @@ zmqpubrawtx=tcp://127.0.0.1:28333

 Once all of the above is complete, and you've confirmed `bitcoind` is fully
 updated with the latest blocks on testnet, run the command below to launch
-`lnd` with `bitcoind` as your backend (as with `bitcoind`, you can create an
+`lnd` with `bitcoind` as your backend (as with `bitcoind`, you can create a


unaddressed

ellemouton · 2024-07-16T12:42:47Z

docs/code_formatting_rules.md

@@ -145,7 +145,7 @@ value, err := bar(

 **Note that the above guidelines don't apply to log or error messages.** For
 log and error messages, committers should attempt to minimize the number of
-lines utilized, while still adhering to the 80-character column limit. For
+lines utilized, while still adhering to the 80-character column limit For


dont think this is correct. Either leave as is, or replace the . For with , for

Should be fixed up now!

ellemouton

lgtm! 🙏

guggero

Thanks. One more request, then we're good to go.

docs/DOCKER.md

docs/fuzz.md

ellemouton reviewed Jul 1, 2024

View reviewed changes

yyforyongyu requested changes Jul 2, 2024

View reviewed changes

mwaite-codes force-pushed the fix-doc-grammar branch from e882b75 to 3b72b28 Compare July 4, 2024 13:28

yyforyongyu added no-itest no-changelog labels Jul 8, 2024

yyforyongyu requested changes Jul 8, 2024

View reviewed changes

bitromortac reviewed Jul 8, 2024

View reviewed changes

mwaite-codes force-pushed the fix-doc-grammar branch from afaf279 to a7ba6a9 Compare July 13, 2024 19:06

ellemouton reviewed Jul 15, 2024

View reviewed changes

docs/INSTALL.md Outdated Show resolved Hide resolved

docs/configuring_tor.md Outdated Show resolved Hide resolved

docs/grpc/java.md Outdated Show resolved Hide resolved

docs/safety.md Outdated Show resolved Hide resolved

mwaite-codes force-pushed the fix-doc-grammar branch 2 times, most recently from 6c94338 to ae523f9 Compare July 15, 2024 16:15

ellemouton reviewed Jul 16, 2024

View reviewed changes

mwaite-codes force-pushed the fix-doc-grammar branch from ae523f9 to a6db2ac Compare July 18, 2024 17:59

ellemouton approved these changes Jul 19, 2024

View reviewed changes

mwaite-codes requested a review from yyforyongyu July 19, 2024 20:02

yyforyongyu approved these changes Jul 22, 2024

View reviewed changes

guggero requested changes Jul 22, 2024

View reviewed changes

docs/DOCKER.md Show resolved Hide resolved

docs/fuzz.md Outdated Show resolved Hide resolved

multi: Fix typos and grammar in multiple docs

e6dca0c

mwaite-codes force-pushed the fix-doc-grammar branch from a6db2ac to e6dca0c Compare July 23, 2024 03:08

guggero approved these changes Jul 23, 2024

View reviewed changes

guggero merged commit 578e1d4 into lightningnetwork:master Jul 23, 2024
16 of 18 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fix various typos in docs for readability #8881

Fix various typos in docs for readability #8881

mwaite-codes commented Jul 1, 2024

coderabbitai bot commented Jul 1, 2024 •

edited

Loading

Review skipped

Chat

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

ellemouton left a comment

ellemouton Jul 1, 2024

mwaite-codes Jul 4, 2024

ellemouton Jul 1, 2024

mwaite-codes Jul 4, 2024

ellemouton Jul 1, 2024

mwaite-codes Jul 4, 2024

ellemouton Jul 1, 2024

ellemouton Jul 1, 2024

mwaite-codes Jul 4, 2024

ellemouton Jul 1, 2024

mwaite-codes Jul 4, 2024

yyforyongyu left a comment

mwaite-codes commented Jul 7, 2024

yyforyongyu left a comment

yyforyongyu Jul 8, 2024

ellemouton Jul 16, 2024

yyforyongyu Jul 8, 2024

bitromortac Jul 8, 2024 •

edited

Loading

mwaite-codes commented Jul 13, 2024

ellemouton left a comment

ellemouton left a comment

ellemouton Jul 16, 2024

ellemouton Jul 16, 2024

mwaite-codes Jul 18, 2024

ellemouton left a comment

guggero left a comment

Fix various typos in docs for readability #8881

Fix various typos in docs for readability #8881

Conversation

mwaite-codes commented Jul 1, 2024

Change Description

Steps to Test

Pull Request Checklist

Testing

Code Style and Documentation

coderabbitai bot commented Jul 1, 2024 • edited Loading

Review skipped

Chat

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

ellemouton left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

yyforyongyu left a comment

Choose a reason for hiding this comment

mwaite-codes commented Jul 7, 2024

yyforyongyu left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

bitromortac Jul 8, 2024 • edited Loading

Choose a reason for hiding this comment

mwaite-codes commented Jul 13, 2024

ellemouton left a comment

Choose a reason for hiding this comment

ellemouton left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ellemouton left a comment

Choose a reason for hiding this comment

guggero left a comment

Choose a reason for hiding this comment

coderabbitai bot commented Jul 1, 2024 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)

bitromortac Jul 8, 2024 •

edited

Loading