From ad40207126d89874ce1d8202e03ae6bc711956d5 Mon Sep 17 00:00:00 2001 From: hackerrdave Date: Tue, 19 Dec 2017 20:28:38 -0500 Subject: [PATCH] provide formatting for lnd references --- README.md | 2 +- docs/code_contribution_guidelines.md | 14 +++++++------- docs/go-fuzz/README.md | 4 ++-- docs/grpc/python.md | 2 +- 4 files changed, 11 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index 3ffa37b3..f150abe3 100644 --- a/README.md +++ b/README.md @@ -34,7 +34,7 @@ Basic of Lightning Technologies. The specifications are currently being drafted by several groups of implementers based around the world including the developers of `lnd`. The set of specification documents as well as our implementation of the specification are still a work-in-progress. With that -said, `lnd` the current status of `lnd`'s BOLT compliance is: +said, the current status of `lnd`'s BOLT compliance is: - [X] BOLT 1: Base Protocol - [X] BOLT 2: Peer Protocol for Channel Management diff --git a/docs/code_contribution_guidelines.md b/docs/code_contribution_guidelines.md index 6c304254..b93ee4b9 100644 --- a/docs/code_contribution_guidelines.md +++ b/docs/code_contribution_guidelines.md @@ -38,7 +38,7 @@ represent real money and introducing bugs and security vulnerabilities can have far more dire consequences than in typical projects where having a small bug is minimal by comparison. In the world of cryptocurrencies, even the smallest bug in the wrong area can cost people a significant amount of money. For this -reason, the Lightning Network Daemon (lnd) has a formalized and rigorous +reason, the Lightning Network Daemon (`lnd`) has a formalized and rigorous development process (heavily inspired by [btcsuite](https://github.com/btcsuite)) which is outlined on this page. @@ -78,7 +78,7 @@ security and performance implications. ### 3. Required Reading -- [Effective Go](http://golang.org/doc/effective_go.html) - The entire lnd +- [Effective Go](http://golang.org/doc/effective_go.html) - The entire `lnd` project follows the guidelines in this document. For your code to be accepted, it must follow the guidelines therein. - [Original Satoshi Whitepaper](https://bitcoin.org/bitcoin.pdf) - This is the white paper that started it all. Having a solid @@ -132,7 +132,7 @@ This approach has several benefits: #### 4.2. Testing -One of the major design goals of all of lnd's packages and the daemon itself is +One of the major design goals of all of `lnd`'s packages and the daemon itself is to aim for a high degree of test coverage. This is financial software so bugs and regressions in the core logic can cost people real money. For this reason every effort must be taken to ensure the code is as accurate and bug-free as @@ -294,7 +294,7 @@ commit which introduced a bug or regression. #### 4.5. Code Spacing -Blocks of code within lnd should be segmented into logical stanzas of +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, proper spacing allows readers to quickly scan code, extracting semantics quickly. @@ -353,8 +353,8 @@ of `protoc`. The following commit hashes of related projects are also required in order to generate identical compiled protos and related files: - * grpc-ecosystem/grpc-gateway: f2862b476edcef83412c7af8687c9cd8e4097c0f - * golang/protobuf: ab9f9a6dab164b7d1246e0e688b0ab7b94d8553e + * grpc-ecosystem/grpc-gateway: `f2862b476edcef83412c7af8687c9cd8e4097c0f` + * golang/protobuf: `ab9f9a6dab164b7d1246e0e688b0ab7b94d8553e` Additionally, in order to maintain a uniform display of the RPC responses rendered by `lncli`, all added or modified `protof` definitions, _must_ attach @@ -377,7 +377,7 @@ itself, and uses a `snake_case` style of name formatting. All added or modified ### 5. Code Approval Process This section describes the code approval process that is used for code -contributions. This is how to get your changes into lnd. +contributions. This is how to get your changes into `lnd`. diff --git a/docs/go-fuzz/README.md b/docs/go-fuzz/README.md index a0f533fd..38f9e806 100644 --- a/docs/go-fuzz/README.md +++ b/docs/go-fuzz/README.md @@ -7,7 +7,7 @@ the `lnd` wire protocol. Lnd uses its own wire protocol to send and receive messages of all types. There are 22 different message types, each with their own specific format. If a -message is not in the correct format, lnd should logically reject the message +message is not in the correct format, `lnd` should logically reject the message and throw an error. But what if it doesn't? What if we could sneakily craft a custom message that could pass all the necessary checks and cause an error to go undetected? Chaos would ensue. However, crafting such a message would require @@ -103,4 +103,4 @@ well with protocols where there is a strict format with validation rules. Fuzzin is important as an automated security tool and can find real bugs in real-world software. The fuzzing of `lnd` is by no means complete and there exist probably many more bugs in the software that may `go` undetected if left unfuzzed. Citizens, -do your part and `go-fuzz` `lnd` today! \ No newline at end of file +do your part and `go-fuzz` `lnd` today! diff --git a/docs/grpc/python.md b/docs/grpc/python.md index 22ab7f3a..cd33bed6 100644 --- a/docs/grpc/python.md +++ b/docs/grpc/python.md @@ -1,7 +1,7 @@ # How to write a Python gRPC client for the Lightning Network Daemon This section enumerates what you need to do to write a client that communicates -with lnd in Python. +with `lnd` in Python. ### Setup and Installation