From 1e7f0d42ad13bfc92f4163bcdc3bffa80ae298a2 Mon Sep 17 00:00:00 2001 From: joao Date: Sat, 17 Feb 2024 20:22:45 -0300 Subject: [PATCH 1/2] docs: fix makefile typo [skip ci] --- docs/MAKEFILE.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/MAKEFILE.md b/docs/MAKEFILE.md index f02501b31..7dbef721a 100644 --- a/docs/MAKEFILE.md +++ b/docs/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=` From 805c1c0d599c94c0997ef7961dee5e3a8a5be025 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jo=C3=A3o=20Thallis?= Date: Sat, 17 Feb 2024 20:49:03 -0300 Subject: [PATCH 2/2] docs: fix contribution guide links [skip ci] --- docs/code_contribution_guidelines.md | 2 +- docs/code_formatting_rules.md | 3 ++- 2 files changed, 3 insertions(+), 2 deletions(-) diff --git a/docs/code_contribution_guidelines.md b/docs/code_contribution_guidelines.md index 90adc57cf..1227f6849 100644 --- a/docs/code_contribution_guidelines.md +++ b/docs/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/code_formatting_rules.md b/docs/code_formatting_rules.md index 1c7421b78..07b2c24c2 100644 --- a/docs/code_formatting_rules.md +++ b/docs/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.