search

roberth / uu-cs-orc

Cloud orchestration project
2 stars 1 forks source link

Comments #8

Open ghost opened 8 years ago

ghost commented 8 years ago

-what policy for comments will we live up to.

-where will we document custom protocols so that they can be revised easily while coding

roberth commented 8 years ago

I suggest writing haddock comments on terms that are exposed by the module. Comments should be user oriented. Provide rationale for the interface, not for the implementation.

I think at this point protocols should be considered experimental and they can be 'generated' trivially using deriving Read.

Any suggestions for more code policy?