Improve comments in our code base

Description

Adding detailed comments to all modules to improve maintainability and make it easier for new contributors

Some improvements in commenting standards can be

  • Comment on each file which mentions last modification date & commit (should be automated)

  • Better description on top of each file

  • Stores should mention on which views are they being used, etc

  • For our 'license', suggest that we just have a 1-liner saying that ~"This code is subject to the Raxa license; as of October 4th, 2012 this license was Apache 2.0. For more details, visit: <url>". That way it won't take up so much space in every file...

Environment

None

Status

Assignee

Nathan Leiby

Reporter

Piyush Madan

Labels

Affects versions

Samosa Cleanup (v0.1.1)

Priority

Critical
Configure