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

Update Documentation #2172

Merged
merged 14 commits into from
Apr 16, 2019
Merged

Update Documentation #2172

merged 14 commits into from
Apr 16, 2019

Conversation

joepetrowski
Copy link
Contributor

Closes #2159

Updates:

Balances

Contract

  • Style, formatting, misspellings

Staking

  • Added links so that it renders on rust stable
  • Enforced max line length of 120 characters

Sudo & System

  • Made common sections consistent with other modules

Timestamp

  • Made common sections consistent with other modules
  • Updated relative links

@parity-cla-bot

This comment has been minimized.

1 similar comment
@parity-cla-bot

This comment has been minimized.

srml/balances/src/lib.rs Outdated Show resolved Hide resolved
srml/balances/src/lib.rs Outdated Show resolved Hide resolved
srml/balances/src/lib.rs Outdated Show resolved Hide resolved
srml/contract/src/lib.rs Outdated Show resolved Hide resolved
srml/contract/src/lib.rs Outdated Show resolved Hide resolved
srml/contract/src/lib.rs Outdated Show resolved Hide resolved
srml/contract/src/lib.rs Outdated Show resolved Hide resolved
/// property (being a proper uniqueid).
/// Get a trie id (trie id must be unique and collision resistant depending upon its context).
/// Note that it is different than encode because trie id should be collision resistant
/// (being a proper uniqueid).
pub trait TrieIdGenerator<AccountId> {
Copy link
Member

Choose a reason for hiding this comment

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

A bit out of scope, but I'm not sure this should be named "Trie". The trie is an abstraction level beyond storage and is an implementation detail as far as the runtime module is concerned. In this case, it's specifically the AccountId that must be a unique identifier, so it should probably be called AccountIdGenerator

cc @pepyakin

srml/system/src/lib.rs Outdated Show resolved Hide resolved
srml/system/src/lib.rs Outdated Show resolved Hide resolved
srml/staking/src/lib.rs Outdated Show resolved Hide resolved
srml/staking/src/lib.rs Outdated Show resolved Hide resolved
Copy link
Member

@gavofyork gavofyork left a comment

Choose a reason for hiding this comment

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

Various corrections.

@joepetrowski
Copy link
Contributor Author

Fixed review comments with the exception of Trie/AccountId naming.

Have changed "To use it in your module..." to "To use it in your runtime..." for modules except the System module, as I think it applies more to modules than runtimes. Correct?

@@ -16,14 +16,14 @@

//! # Contract Module
//!
//! The contract module provides functionality for the runtime to deploy and execute WebAssembly smart-contracts.
//! The supported dispatchable functions are documented as part of the [`Call`](./enum.Call.html) enum.
Copy link
Member

Choose a reason for hiding this comment

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

Why did you remove the Call enum here?

Copy link
Contributor Author

@joepetrowski joepetrowski Apr 10, 2019

Choose a reason for hiding this comment

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

I moved it to the Dispatchable Functions section so that you see a link from the brief summaries to the more detailed documentation. This is also consistent with where other modules have put this link.

srml/contract/src/lib.rs Show resolved Hide resolved
//! You can start using the sudo module by implementing the sudo [`Trait`].
//!
//! Supported dispatchable functions are documented in the [`Call`] enum.
//! You can start using the Sudo module by implementing the [`sudo::Trait`](./trait.Trait.html).
Copy link
Member

Choose a reason for hiding this comment

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

Here you also dropped Call?

srml/sudo/src/lib.rs Outdated Show resolved Hide resolved
Co-Authored-By: joepetrowski <25483142+joepetrowski@users.noreply.github.com>
@shawntabrizi shawntabrizi added A0-please_review Pull request needs code review. and removed A4-gotissues labels Apr 16, 2019
@bkchr bkchr merged commit c2db9dc into master Apr 16, 2019
@bkchr bkchr deleted the joe-refdocs-update branch April 16, 2019 13:35
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.

Clean up merged documentation
6 participants