Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve repository readability and documentation #4

Open
ndd7xv opened this issue Aug 9, 2022 · 0 comments
Open

Improve repository readability and documentation #4

ndd7xv opened this issue Aug 9, 2022 · 0 comments
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@ndd7xv
Copy link
Owner

ndd7xv commented Aug 9, 2022

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 ndd7xv added the documentation Improvements or additions to documentation label Aug 9, 2022
@ndd7xv ndd7xv mentioned this issue Aug 10, 2022
@ndd7xv ndd7xv self-assigned this Aug 18, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant