Add top-level documentation.

NicolasT / kontiki

An implementation of the Raft consensus protocol

BSD 3-Clause "New" or "Revised" License

122 stars 15 forks source link

Add top-level documentation. #6

Closed jkozlowski closed 11 years ago

jkozlowski commented 11 years ago

Updated README.md.

Added build/test instructions.
Added contribution ideas.
Added udp demo description and example output.

Added top level documentation to all modules.

sometimes a bit pointless, but Network.Kontiki.Types is now relatively well documented with references to the paper, sections and ordering of definitions the same as exports.

Enabled test coverage with hpc.

Updated README.md with appropriate instructions.

jkozlowski commented 11 years ago

This is a result of my going through the code to understand it. Next will be tests jkozlowski/kontiki#2.

qrilka commented 11 years ago

Without any docs (like in current kontiki master) it's much harder to understand library code So I vote for your effort Jakub

jkozlowski commented 11 years ago

Thanks, would appreciate if someone would review as well, just so we know if those actually make sense. But I think I covered most cases.

I initially started adding comments to the handle* methods inside, but later got rid of them as I realised that bit is very readable and understandable.

NicolasT commented 11 years ago

I'll give this a more thorough review in the coming days. The intent is certainly good, so thanks for working on this and contributing. I'll get back to you asap.

jkozlowski commented 11 years ago

Applied the two suggestions.

NicolasT commented 11 years ago

Sorry, I didn't went through all changes before. Will do so now.

NicolasT commented 11 years ago

I'm not a big fan of some of the formatting changes, but heck, this is 100% better than no documentation at all, so thanks a lot and kuddos to you for doing this! A big help!

jkozlowski commented 11 years ago

Now that I read through the diff, I don't like some of them either :) I suppose I might have been hoping for a thorough code review, but I'm happy to have contributed.

Hopefully my tests will go down better, when I finish them :)