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

Code cleanup #17

Closed
vsreekanti opened this issue Aug 31, 2016 · 3 comments
Closed

Code cleanup #17

vsreekanti opened this issue Aug 31, 2016 · 3 comments
Assignees
@vsreekanti
Milestone
v0.1

Comments

@vsreekanti
Copy link
Member

General cleanup, deduplication of code, addressing of TODOs, etc. Also, write proper documentation for everything.
@vsreekanti vsreekanti added this to the v0.1 milestone Aug 31, 2016
@vsreekanti vsreekanti self-assigned this Aug 31, 2016
@vsreekanti
Copy link
Member Author

This includes things like testing, refactoring, etc.

@vsreekanti
Copy link
Member Author

vsreekanti commented Sep 7, 2016 •
edited
Loading

Things involved in code cleanup:

  • Internal documentation: Comment all non-private functions and explain all non-obvious pieces of code.
  • Test refactoring: Most tests right now are integration tests that subsume unit tests that should exist. Integration tests shouldn't test edge cases in particular implementations; unit tests should.
  • Remove Optional: According to the creators of the Java 8 Optional, our usage of Optional is not intended. Remove it and go back to using null.
  • Refactoring: There are a few places where code is duplicated and could probably be refactored with a little bit of effort.
  • TODOs: Any code that should change but is too much surgery for the time or out-of-scope for the MVP should be appropriately documented.

@vsreekanti
Copy link
Member Author

Resolved as of 1e1a730.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@vsreekanti vsreekanti

Labels
None yet
Projects
None yet
Milestone
v0.1
Development

No branches or pull requests
1 participant
@vsreekanti