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

Turning in Mini-Project 3 #8

Open
wants to merge 8 commits into
base: master
Choose a base branch
from

Conversation

ewesterhoff
Copy link

No description provided.

@Elepert
Copy link

Elepert commented Oct 15, 2017

Overall this is really good. Just a few notes on documentation (this is all extra stuff, your documentation is good for this project):

  • Because you separated your code into multiple files (which is good), you should add header comments at the top of your files, so readers can understand what each file is doing.
  • When documenting code, explaining how files relate to one another is good pratice (when we get to UML diagrams this'll be clear)
  • You did this for some files, but not all, explaining what the inputs and outputs of functions are and what type they are is always good.
    Stylistically (this is super minor):
  • Some of your for loops use "i" and "x" when indexing into lists or strings. Having "word" or "letter" would make more sense from a reader's standpoint.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants