heh icon indicating copy to clipboard operation
heh copied to clipboard

Improve repository readability and documentation

Open ndd7xv opened this issue 2 years ago • 0 comments

As per this feedback,

  • Give more spacing between functions
  • Add comments to generate rustdoc
  • Add additional comments on obscure code

I'm extending this beyond the listed recommendations because the suggestions are a part of the bigger idea to make this repo understandable - if there's anything that needs to be changed (or you think should be added) in the README, typos in a comment, or a refactoring of unidiomatic/messy code, those changes (whether they be in a different PR or not) are welcome to reference this issue.

ndd7xv avatar Aug 09 '22 04:08 ndd7xv