Documentation for the timestamp module

[gautamdhameja]

• Added code comments in the lib.rs of the timestamp module
• Added readme.md in the root of timestamp module crate. This file has the module docs as per the SRML documentation template.

[parity-cla-bot]

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

Many thanks,

Parity Technologies CLA Bot

[parity-cla-bot]

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

Many thanks,

Parity Technologies CLA Bot

[kianenigma]

Whenever I wanted to learn about a new srml, lack of explanation on the test cases was quite a barrier. I would recommend putting some explanatory docs on the tests as well since they should cover the common use cases of the module + common error/edge cases. Hence, I think they are quite important and should be documented + potentially linked as a further source of learning at the end of the .md file.

[ltfschoen]

Is there any opportunity to incorporate: https://github.com/paritytech/substrate/blob/master/README.adoc#72-contributing-to-documentation-for-substrate-packages

[ltfschoen]

great work so far! i've left some nitpick comments

[gui1117]

some general thoughts:

in rustdoc to make link you can write [NameOfTheStuff] and then at the end of the doc after an empty line you write [NameOfTheStuff]: struct.NameOfTheStuff.html

look at ./core/sr-sandbox/src/lib.rs line 79 for example

using this method a lot of types can be referenced. like block_period, set, get etc...

also I'm not sure some /// doc on private function with expressfull name is useful.

[bkchr]

in rustdoc to make link you can write [NameOfTheStuff] and then at the end of the doc after an empty line you write [NameOfTheStuff]: struct.NameOfTheStuff.html

You don't need to do this anymore, just write [NameOfTheStuff] and it works. Rustdocs supports intra doc links for some time now.

[gui1117]

in rustdoc to make link you can write [NameOfTheStuff] and then at the end of the doc after an empty line you write [NameOfTheStuff]: struct.NameOfTheStuff.html

You don't need to do this anymore, just write [NameOfTheStuff] and it works. Rustdocs supports intra doc links for some time now.

it seems to be the case on nightly only

[shawntabrizi]

I have 2 suggestions, but nothing that should block a merge

[ltfschoen]

LGTM, left a couple more nitpick

[shawntabrizi]

🥇