[do not merge] Make some higher level comments about the code #3
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Do not merge this pull request, I merely used this as a convenient way to comment :-)
Below are some first thoughts I had when looking through the source code. In general I find the code relatively simple to read (which is very good), but there is room for improvement regarding the structure of the overall program. For example you currently implement everything in header files, with just a single source file (main.cpp) including all of the headers. Was this a conscious decision, or would you be fine spliting them into header/source file pairs? That would allow for a better documentation of the individual functions.
Overall my comments below are not as important as the ones I raised in #2, and #2 should be addressed first before addressing the comments in this pull request.