-
Notifications
You must be signed in to change notification settings - Fork 9
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
Inline Documenation #17
Comments
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? |
@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. |
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 |
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 |
@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 |
Hello there devin! If the issue has not been completely resolved, I'd love to help. :D |
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
The text was updated successfully, but these errors were encountered: