search

iamtrask / Sonar

DEPRECATED - Decentralized Machine Learning Server (hosted on Blockchain)
Apache License 2.0
141 stars 49 forks source link

Update Documentation #33

Closed jeamick closed 6 years ago

jeamick commented 6 years ago

Little change to make to smart-contracts more clear

axelhodler commented 6 years ago

Having these comments by itself to structure the code is not helpful I believe. Just a matter of time someone adds a modifier between the public functions or makes one of the public functions private.

If our goal is to make it super easy for a datascientist to grasp what the code does we should probably elaborate what a modifier or a public function is supposed to be.

iamtrask commented 6 years ago

I'm a big supporter of more comments / descriptions in this repo... @jeamick perhaps you'd be willing to elaborate in a bit more detail in your commenting?

jeamick commented 6 years ago

sorry, @axelhodler I wanted to make more changes in order to update the documentation of the functions just to be more clear about the code.

axelhodler commented 6 years ago

sorry @jeamick for the late answer. Feel free to improve any docs around here. The conflicts should be resolved though.

Aside from the above, can you think of a good way we could enforce the truth of the comments? Such as that no one would add non-modifiers under the /* Modifiers / comment?

jeamick commented 6 years ago

huh ? I didn't get really well what you were saying ...