Inline Documenation

[devinmatte]

I'm terrible at documenting my code. Mostly because I would just rather work on functionality.

Document all functions with a docstring giving an overview of the function, and links to what portion of the file it builds on.

This is an ongoing issue

[ftakj]

Hey Devin,

This will be my first time looking to help out on github. Going to fork the repo and start taking a look at the code. Looks like you need help with the documentation to start?

[devinmatte]

@ftakj I would appreciate some help. I'm incredibly lazy when it comes to documentation despite knowing how important it is.

Because I want people to be able to help with this project some inline documentation would be great. Feel free to document what makes sense, and ask any questions here or as a separate issue if it requires detailed explanation.

[ftakj]

Thanks devin, just submitted my first pull request (as I'm sure you saw). Hopefully that was done properly. I'll go through the code and see what parts I can understand as I'm still a beginner / intermediate with python

[ftakj]

Ok @devinmatte submitted another pull request this time with a docstring for the first is_hex_color function. Wanted to double check thats what you're looking for before moving on

[devinmatte]

@ftakj That looks fine. Keep it up. I'll review it sometime this weekend. Before I merge I'll want you to squash and rebase your commits

[devarshigoswami]

Hello there devin! If the issue has not been completely resolved, I'd love to help. :D