ERC20Votes docs

[ericnordelo]

Partially fixes #815

PR Checklist

• Tests
• Documentation
• Added entry to CHANGELOG.md
• Tried the feature on a public network

[andrew-fleming]

The docs are looking good, Eric! I left some comments and questions

[andrew-fleming]

I get not documenting structs because of the forthcoming native StorageArray; however, I feel like we should at least mention that this code is temporary. I'm not sure where exactly. Thoughts? Let's also not forget to track this as an issue once we're merged

And math should be stable enough to document, no?

[ericnordelo]

math documented!

Regarding Checkpoint and Trace I don't think we need to document them, since they are not intended as part of the library public API, they are just helpers for the erc20votes extension. Maybe we can move them outside of the utilities folder.

Regarding StorageArray, I don't think is worth documenting it since we don't want to support it, but to remove it in favor of the native implementation. Not sure where to mention that StorageArray is a temporal solution either, I vote we leave it for a different issue as well.

[ericnordelo]

#969

[andrew-fleming]

The [key] is not visually appealing :( though I think this should be included. For the sake of consistency, how do you feel about making this a separate issue so we can tackle all of the APIs at once?

[ericnordelo]

I think we should prioritize showing which keys are indexed, but agree maybe is better for a different issue, since we are releasing next week.

[ericnordelo]

#968

[andrew-fleming]

Also, the readme code block needs ERC20HooksEmptyImpl

[andrew-fleming]

Left a final two suggestions (it's really just one). Otherwise, I think this is good to go!