0xPolygonZero / eth-trie-tools

Various debugging tools for working with tries for `eth_trie_utils`.
1 stars 2 forks source link

Add documentation #3

Open Nashtare opened 7 months ago

Nashtare commented 7 months ago

Add documentation throughout the workspace + README for easier use by external parties.

Ideally supporting

#![cfg_attr(docsrs, feature(doc_cfg))]
#![deny(rustdoc::broken_intra_doc_links)]
#![deny(missing_docs)]
Nashtare commented 7 months ago

@BGluth Assigning myself to it so I can dive into the internals and understand them while writing the doc, if you don't mind!