From 1129110be3355f8e06610f94850fdb7f666c5404 Mon Sep 17 00:00:00 2001 From: seelabs Date: Tue, 15 Sep 2020 19:20:06 -0400 Subject: [PATCH] Document unused SHAMap constructor parameter --- src/ripple/shamap/impl/SHAMap.cpp | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/src/ripple/shamap/impl/SHAMap.cpp b/src/ripple/shamap/impl/SHAMap.cpp index dd8ae5106..700b63358 100644 --- a/src/ripple/shamap/impl/SHAMap.cpp +++ b/src/ripple/shamap/impl/SHAMap.cpp @@ -32,6 +32,10 @@ SHAMap::SHAMap(SHAMapType t, Family& f) root_ = std::make_shared(seq_); } +// The `hash` parameter is unused. It is part of the interface so it's clear +// from the parameters that this is the constructor to use when the hash is +// known. The fact that the parameter is unused is an implementation detail that +// should not change the interface. SHAMap::SHAMap(SHAMapType t, uint256 const& hash, Family& f) : f_(f) , journal_(f.journal())