Skip to content

Improve repository readability and documentation #4

Description

@ndd7xv

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.

Metadata

Metadata

Assignees

Labels

documentationImprovements or additions to documentation

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions