david-yz-liu / memory-viz

Javascript library for creating beginner-friendly memory model diagrams.
https://www.cs.toronto.edu/~david/memory-viz/demo/
2 stars 7 forks source link

Documentation-A #1

Closed mimischly7 closed 1 year ago

mimischly7 commented 1 year ago

Utku and I worked in creating documentation for the given code. This is the first phase, including all docstrings and inline comments to aid the understanding of anyone reading the code. The second phase will be developed alongside the tasks we are assigned, and it will be a more formal API of the memory-models projects (much like the API of Rough.js seen in the README.md file of Rough in Github).