Skip to content
This repository was archived by the owner on Nov 15, 2023. It is now read-only.

Documentation for Aura Consensus Extension #2074

Merged
merged 19 commits into from
Apr 16, 2019
Merged

Documentation for Aura Consensus Extension #2074

merged 19 commits into from
Apr 16, 2019

Conversation

4meta5
Copy link
Contributor

@4meta5 4meta5 commented Mar 21, 2019

polkadot-developers/substrate-developer-hub.github.io#23
Changes

  • added docs at the top of lib.rs and some comments throughout the file

ToDo

  • could use some examples of use, but I am not entirely sure about consensus configuration in general; I think a lot of work is being done to make this more clear Swappable Consensus #1304
  • could use more testing with staking and balances specifically wrt using Staking::offline_slash_grace and then testing slashing with the StakingSlasher struct in the module

@4meta5 4meta5 added A0-please_review Pull request needs code review. M3-docs labels Mar 21, 2019
@parity-cla-bot
Copy link

It looks like @amarrsingh signed our Contributor License Agreement. 👍

Many thanks,

Parity Technologies CLA Bot

1 similar comment
@parity-cla-bot
Copy link

It looks like @amarrsingh signed our Contributor License Agreement. 👍

Many thanks,

Parity Technologies CLA Bot

gui1117
gui1117 reviewed Mar 22, 2019
View reviewed changes
Copy link
Contributor

@gui1117 gui1117 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

also you can document the last method on module by documentating the storage (ie move // comment to /// works)

gui1117
gui1117 reviewed Mar 25, 2019
View reviewed changes
Copy link
Contributor

@gui1117 gui1117 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

documentation on trait implementation were also there no ?

gui1117 and others added 14 commits March 25, 2019 16:26
@gui1117 @4meta5
Update srml/aura/src/lib.rs
2614a6d 
Co-Authored-By: AmarRSingh <[email protected]>
@gui1117 @4meta5
Update srml/aura/src/lib.rs
0f67511 
Co-Authored-By: AmarRSingh <[email protected]>
@gui1117 @4meta5
Update srml/aura/src/lib.rs
42334dc 
Co-Authored-By: AmarRSingh <[email protected]>
@gui1117 @4meta5
Update srml/aura/src/lib.rs
5a5a6b3 
Co-Authored-By: AmarRSingh <[email protected]>
@gui1117 @4meta5
Update srml/aura/src/lib.rs
390c9a5 
Co-Authored-By: AmarRSingh <[email protected]>
@gui1117 @4meta5
Update srml/aura/src/lib.rs
54aa4e1 
Co-Authored-By: AmarRSingh <[email protected]>
@gui1117 @4meta5
Update srml/aura/src/lib.rs
f111aac 
Co-Authored-By: AmarRSingh <[email protected]>
@gui1117 @4meta5
Update srml/aura/src/lib.rs
535ff04 
Co-Authored-By: AmarRSingh <[email protected]>
@4meta5
formatting
078f1ec
@4meta5
Merge branch 'amar-aura-docs2' of https://github.com/paritytech/subst…
341cd7d 
…rate into amar-aura-docs2
@joepetrowski
Merge remote-tracking branch 'origin/master' into amar-aura-docs2
7c9b018
@joepetrowski
style and links
5e43367
@4meta5
clean up
0d7378f
@joepetrowski
capitalization
2a0bca8
bkchr
bkchr suggested changes Apr 12, 2019
View reviewed changes
@shawntabrizi shawntabrizi requested a review from bkchr April 12, 2019 09:19
@shawntabrizi shawntabrizi removed A0-please_review Pull request needs code review. A4-gotissues labels Apr 12, 2019
@gui1117 gui1117 merged commit 0eabb14 into master Apr 16, 2019
@joepetrowski joepetrowski deleted the amar-aura-docs2 branch April 16, 2019 19:55
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@gui1117 gui1117 gui1117 left review comments

@bkchr bkchr bkchr approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
7 participants
@4meta5 @parity-cla-bot @bkchr @gui1117 @shawntabrizi @devops-parity @joepetrowski