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

Code needs to be cleaned up more #108

Open
1 of 5 tasks
JacksonElia opened this issue Nov 27, 2024 · 3 comments
Open
1 of 5 tasks

Code needs to be cleaned up more #108

JacksonElia opened this issue Nov 27, 2024 · 3 comments
Labels
documentation Improvements or additions to documentation misc Miscellaneous changes

Comments

@JacksonElia
Copy link
Member

JacksonElia commented Nov 27, 2024

Honestly our code is pretty good at this point, but it could always be better. We need to:

  • Clean up constants.py
  • Add comments to the tests (oh boy)
  • Do another go at changing var names and function names to be clearer and convey more info
  • Flesh out scripts/ a little more, maybe add a nicer UI for them or something
  • Expand the readme, maybe add a little more documentation/guidance where to start for new members
@JacksonElia JacksonElia added documentation Improvements or additions to documentation misc Miscellaneous changes labels Nov 27, 2024
@harshil21
Copy link
Member

Duplicate of #38

@harshil21 harshil21 marked this as a duplicate of #38 Nov 28, 2024
@wlsanderson
Copy link
Contributor

Duplicate of #38

so real

@harshil21
Copy link
Member

Flesh out scripts/ a little more, maybe add a nicer UI for them or something

This can probably be done along with/after #106.

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 misc Miscellaneous changes
Projects
None yet
Development

No branches or pull requests

3 participants