Skip to content

Tags: 0xPolygon/edge-contracts

Tags

pre-alpha

Toggle pre-alpha's commit message

Partially verified

This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.
We cannot verify signatures from co-authors, and some of the co-authors attributed to this commit require their commits to be signed.
add natspec and documentation (#54) (#56)

* add natspec and documentation (#54)

* added dodoc, started rewriting README

* finished first pass on README

* updated .env.example

* move IStateReceiver to interfaces/

* added natspec to common/

* docs: add natspec for `ChildValidatorSet`

* docs: fix some natspec

* natspec for libs

* natspec on cvs for initialize

* natspec finished for root

* improving natspec, additional READMEs

* delete TODO

* fixes, recompile docs

* docs: clarify some `ChildValidatorSet` natspec

* fixes II

Co-authored-by: Zero Ekkusu <[email protected]>
Co-authored-by: gretzke <[email protected]>

* prettier

Co-authored-by: Zero Ekkusu <[email protected]>
Co-authored-by: gretzke <[email protected]>