From 66e8eec194e7da516fa09e3f89ebea813adf9b34 Mon Sep 17 00:00:00 2001 From: "mergify[bot]" <37929162+mergify[bot]@users.noreply.github.com> Date: Mon, 11 Oct 2021 19:49:25 -0700 Subject: [PATCH] light: Update links in package docs. (#7099) (#7101) Fixes #7098. The light client documentation moved to the spec repository. I was not able to figure out what happened to light-client-protocol.md, it was removed in #5252 but no corresponding file exists in the spec repository. Since the spec also discusses the protocol, this change simply links to the spec and removes the non-functional reference. Alternatively we could link to the top-level [light client doc](https://docs.tendermint.com/master/tendermint-core/light-client.html) if you think that's better. (cherry picked from commit 48295955edfd50b24fef42f1e96f7c54333c1ca8) Co-authored-by: M. J. Fromberger --- light/doc.go | 9 +++------ 1 file changed, 3 insertions(+), 6 deletions(-) diff --git a/light/doc.go b/light/doc.go index 700bbeb6c..c30c68eb0 100644 --- a/light/doc.go +++ b/light/doc.go @@ -94,7 +94,7 @@ Check out other examples in example_test.go ## 2. Pure functions to verify a new header (see verifier.go) Verify function verifies a new header against some trusted header. See -https://github.com/tendermint/spec/blob/master/spec/consensus/light-client/verification.md +https://github.com/tendermint/spec/blob/master/spec/light-client/verification/README.md for details. There are two methods of verification: sequential and bisection @@ -118,10 +118,7 @@ as a wrapper, which verifies all the headers, using a light client connected to some other node. See -https://docs.tendermint.com/master/tendermint-core/light-client-protocol.html -for usage example. -Or see -https://github.com/tendermint/spec/tree/master/spec/consensus/light-client -for the full spec +https://github.com/tendermint/spec/tree/master/spec/light-client +for the light client specification. */ package light