search

FizzyFlow / Flow

:ocean: The Flow. Smart money blockchain written in javascript
GNU Affero General Public License v3.0
2 stars 1 forks source link

docs! #10

Open jeka-kiselyov opened 6 years ago

jeka-kiselyov commented 6 years ago

Most important, as there're many classes extending EventEmmiter - is to have some doc files with information about events emitting by each class there. But general docblocks for methods whould be cool to.

jeka-kiselyov commented 6 years ago

As part of this research - write out some convention for events naming/params, as there's some mess already with it.

banguit commented 6 years ago

Yes, I think we need to cover all API by JSDoc. Because currently it's looks a little bit messy.