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

Documentation for consensus module#2043

Merged
gavofyork merged 13 commits intomasterfrom
amar-consensus-docs
Mar 29, 2019
Merged

Documentation for consensus module#2043
gavofyork merged 13 commits intomasterfrom
amar-consensus-docs

Conversation

@amarsinghcodes
Copy link
Contributor

@amarsinghcodes amarsinghcodes commented Mar 19, 2019

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

  1. Documentation for the consensus module at the top of lib.rs
  2. Change comments that reference next_session to rotate_session because I don't think next_session exists but there are comments in this module and srml/session to this function...the name must have changed at some point
  3. Added a unit test for the partial change of the authorities set (because it seems that there were only tests for complete change and no change). Test passed.

@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

@amarsinghcodes amarsinghcodes changed the title Documentation for Consensus Module (in srml) Documentation for consensus module Mar 19, 2019
@amarsinghcodes amarsinghcodes added A0-please_review Pull request needs code review. M3-docs labels Mar 19, 2019
Copy link
Contributor

@joepetrowski joepetrowski left a comment

Choose a reason for hiding this comment

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

(sorry for not combining all comments in review)

Just general style comments. Also all lines should be fewer than 120 characters.

joepetrowski and others added 2 commits March 26, 2019 16:21
Co-Authored-By: AmarRSingh <asinghchrony@protonmail.com>
joepetrowski and others added 4 commits March 27, 2019 10:54
Co-Authored-By: AmarRSingh <asinghchrony@protonmail.com>
Co-Authored-By: AmarRSingh <asinghchrony@protonmail.com>
Co-Authored-By: AmarRSingh <asinghchrony@protonmail.com>
@gavofyork gavofyork merged commit d2a6907 into master Mar 29, 2019
@gavofyork gavofyork deleted the amar-consensus-docs branch March 29, 2019 16:41
MTDK1 pushed a commit to bdevux/substrate that referenced this pull request Apr 12, 2019
* first try

* resolve description of grandpa and add links to relevant docs

* Update srml/consensus/src/lib.rs

Co-Authored-By: AmarRSingh <asinghchrony@protonmail.com>

* Can do a relative link here

* Update srml/consensus/src/lib.rs

Co-Authored-By: AmarRSingh <asinghchrony@protonmail.com>

* Update srml/consensus/src/lib.rs

Co-Authored-By: AmarRSingh <asinghchrony@protonmail.com>

* Update srml/consensus/src/lib.rs

Co-Authored-By: AmarRSingh <asinghchrony@protonmail.com>

* formatting/style/semantics

* missed conflict

* style

* Update srml/consensus/src/lib.rs

* Update srml/consensus/src/lib.rs
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

A0-please_review Pull request needs code review.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

9 participants