Document variables / functions in wiki to reduce comment clutter throughout codebase

melsonGit / serial_cpp_vs_parallel_cuda

Code work for completion of MSc ICT. The original version of this project was submitted alongside a 15,000 word thesis paper and put into practice the theoretical CPU and GPGPU/GPU elements explored in the write-up. I continued to develop this project post-graduation.

0 stars 1 forks source link

Document variables / functions in wiki to reduce comment clutter throughout codebase #7

Closed melsonGit closed 2 years ago

melsonGit commented 2 years ago

Issue

Comment clutter throughout codebase makes files look very messy. Move comments (not all) into a wiki.

Additional Info

A wiki will lead to a cleaner and easier to follow codebase. Additionally, it would provide an opportunity to further elaborate on certain variables / functions that will benefit from more description.

melsonGit commented 2 years ago

Commit e1cdf8f906fc3b9cbd3c8f325fdd6d2d1d949f6b somewhat resolved this issue with comments explaining the inheretly ambiguous nature of GPU CUDA code. For the time being, I don't believe the current scope of this project requires a dedicated wiki.