Polish class API documentation - Githubissues

shogun-toolbox / shogun

Shōgun

http://shogun-toolbox.org

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

3.03k stars 1.04k forks source link

Polish class API documentation #3629

Open karlnapf opened 7 years ago

karlnapf commented 7 years ago

Many of Shogun's classes do not have proper class documentation, i.e. they

are written in bad English (spelling, punctuation, etc)
are written without or wiht bad math (not use Latex, messy)
do not explain what the class can do, or how it is implemented
do not talk about the computational load to be expected when running it
do not give appropriate references to the papers describing the algorithms
do not have any docs at all (In particular the @brief field

Pick one and you got a nice minimal contribution

ShashwatSingh1999 commented 2 years ago

Hey want to know if this issue is still open? could you assign it to me?