From e6ca278ff84b95dd020ea5b6377ab8e3ca41852d Mon Sep 17 00:00:00 2001 From: GitHub Date: Tue, 20 Feb 2024 00:16:29 +0000 Subject: [PATCH] update documentation --- docs/lnd/MAKEFILE.md | 2 +- docs/lnd/code_contribution_guidelines.md | 2 +- docs/lnd/code_formatting_rules.md | 3 ++- 3 files changed, 4 insertions(+), 3 deletions(-) diff --git a/docs/lnd/MAKEFILE.md b/docs/lnd/MAKEFILE.md index f02501b3..7dbef721 100644 --- a/docs/lnd/MAKEFILE.md +++ b/docs/lnd/MAKEFILE.md @@ -95,7 +95,7 @@ Related: [`unit`](#unit) `flakehunter` ------------- -Runs the itegration test suite endlessly until a failure is detected. +Runs the integration test suite endlessly until a failure is detected. Arguments: - `icase=` diff --git a/docs/lnd/code_contribution_guidelines.md b/docs/lnd/code_contribution_guidelines.md index 90adc57c..1227f684 100644 --- a/docs/lnd/code_contribution_guidelines.md +++ b/docs/lnd/code_contribution_guidelines.md @@ -86,7 +86,7 @@ security and performance implications. - 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): - [Lightning Network Summary](https://lightning.network/lightning-network-summary.pdf) - [Understanding the Lightning Network 3-Part series](https://bitcoinmagazine.com/articles/understanding-the-lightning-network-part-building-a-bidirectional-payment-channel-1464710791) - - [Deployable Lightning](https://github.com/ElementsProject/lightning/blob/master/doc/deployable-lightning.pdf) + - [Deployable Lightning](https://github.com/ElementsProject/lightning/blob/master/doc/miscellaneous/deployable-lightning.pdf) Note that the core design of the Lightning Network has shifted over time as diff --git a/docs/lnd/code_formatting_rules.md b/docs/lnd/code_formatting_rules.md index 1c7421b7..07b2c24c 100644 --- a/docs/lnd/code_formatting_rules.md +++ b/docs/lnd/code_formatting_rules.md @@ -16,7 +16,8 @@ in `lnd` to help improve the overall readability. Blocks of code within `lnd` should be segmented into logical stanzas of operation. Such spacing makes the code easier to follow at a skim, and reduces -unnecessary line noise. Coupled with the commenting scheme specified above, +unnecessary line noise. Coupled with the commenting scheme specified in the +[contribution guide](./code_contribution_guidelines.md#code-documentation-and-commenting), proper spacing allows readers to quickly scan code, extracting semantics quickly. Functions should _not_ just be laid out as a bare contiguous block of code.