doc: aligns the nmt API doc with the current implementation

celestiaorg / nmt

Namespaced Merkle Tree

Apache License 2.0

107 stars 39 forks source link

doc: aligns the nmt API doc with the current implementation #215

Closed staheri14 closed 1 year ago

staheri14 commented 1 year ago

Overview

Closes #213

Checklist

[x] New and updated code has appropriate documentation
[x] New and updated code has new and/or updated testing
[x] Required CI checks are passing
[x] Visual proof for any user facing features like CLI or documentation updates
[x] Linked issues closed with keywords

codecov[bot] commented 1 year ago

Codecov Report

Merging #215 (1f97958) into master (9f0f36e) will not change coverage. The diff coverage is n/a.

@@           Coverage Diff           @@
##           master     #215   +/-   ##
=======================================
  Coverage   93.67%   93.67%           
=======================================
  Files           5        5           
  Lines         601      601           
=======================================
  Hits          563      563           
  Misses         21       21           
  Partials       17       17