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.

Sign up for GitHub

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

Jump to bottom

readability: review the repo, document and comment for readability #100

Open
Tracked by #98
thor314 opened this issue Oct 21, 2024 · 0 comments
Open
Tracked by #98

readability: review the repo, document and comment for readability #100

thor314 opened this issue Oct 21, 2024 · 0 comments
Assignees
@thor314
Labels
documentation 📜 Improvements or additions to documentation

Comments

@thor314
Copy link
Contributor

thor314 commented Oct 21, 2024 •
edited
Loading

Repo has many areas that could use readibility improvements, particularly in folding. Document function stubs, and attempt to improve the readability of the codebase, with further references documented either in readme or some other reasonable location.

Augments repo cleaning performed in #96. Est 2-4h work.
@thor314 thor314 mentioned this issue Oct 21, 2024
Open
4 tasks
@thor314 thor314 changed the title review the repo, document and comment for readability readability: review the repo, document and comment for readability Oct 21, 2024
@thor314 thor314 self-assigned this Oct 21, 2024
@thor314 thor314 added the documentation 📜 Improvements or additions to documentation label Oct 21, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@thor314 thor314

Labels
documentation 📜 Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@thor314