Documentation for the Democracy Module

[ltfschoen]

Relates to polkadot-developers/substrate-developer-hub.github.io#28

Requires update for consistency with #2172

[joepetrowski]

A lot of code exceeded our style guide length limit. Fixed in most recent commit, but can be rolled back if we want this to be strictly comments.

[ltfschoen]

@joepetrowski the indentation didn't look right in the code snippet when i ran cargo doc --package srml-democracy --open. it was ok on lines where indentation had been done using spaces, but not when indentation had been done using tabs, so i just removed the tabs and replaced them with spaces

[DemiMarie-temp]

The specific threshold for a supermajority should be specified.

[DemiMarie-temp]

How large a supermajority is needed? This should be documented.

[joepetrowski]

See update

[ltfschoen]

i've received feedback from rpmeier suggesting that we providing information about what origin the proposed call is executed with

[ltfschoen]

@shawntabrizi why are you force pushing and deleting all the commit history from other contributors? why not just ask me to close this PR and create a fresh branch of your own instead of discrediting our work?

[shawntabrizi]

@ltfschoen I am not intending to discredit any work here, but these docs have been stale and were originally opened to merge to the master branch.

Since the SRML Democracy module has changed quite a bit in master, we re-targeted this branch to merge to v1.0.

However, at certain points this branch was re-based or merged with the master branch which means that when we changed the base branch to v1.0, we were getting changes on the order of 400+ files changed.

I isolated the changes and fixed up the PR. There could probably be a better way to do this, but end of the day, I just want to get these docs merged in.

[ltfschoen]

Fair enough, thanks for cleaning it up!

[ltfschoen]

I've left review comments with various nitpicks.

[ltfschoen]

With regard to the actual implementation, I came up with the following questions:

1. In the implementation of set_proxy https://github.com/paritytech/substrate/pull/2286/files#diff-cbe2b253de4fb4f87ccc41b9075568d6R305, how are we checking that it is actually being called by a stash account as expected (rather than being called by a proxy account for instance)? do we need an additional assertion?

2. In the implementation of resign_proxy https://github.com/paritytech/substrate/pull/2286/files#diff-cbe2b253de4fb4f87ccc41b9075568d6R312, how are we checking that it is actually being called by a proxy account as expected (rather than being called by a stash account for instance)? do we need an additional assertion?

3. In the implementation of remove_proxy https://github.com/paritytech/substrate/pull/2286/files#diff-cbe2b253de4fb4f87ccc41b9075568d6L176, how are we checking that it is actually being called by a stash account as expected (rather than being called by a proxy account for instance)? do we need an additional assertion?

[joepetrowski]

A few small fixes, otherwise LGTM.