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

Refactor, Add Documentation, and Enforce Type Hints #14

Open
zacharyrperales opened this issue May 7, 2023 · 0 comments
Open

Refactor, Add Documentation, and Enforce Type Hints #14

zacharyrperales opened this issue May 7, 2023 · 0 comments
Assignees
@zacharyrperales

Comments

@zacharyrperales
Copy link
Owner

The codebase needs to be cleaned up, documentation added, and type hinting enforced. We should reference the Google Python Style Guide for documenting modules and functions and methods.
@zacharyrperales zacharyrperales changed the title Refactor, Add Documentation, and Enforce Type Hinting Refactor, Add Documentation, and Enforce Type Hints May 7, 2023
@zacharyrperales zacharyrperales self-assigned this May 7, 2023
zacharyrperales added a commit that referenced this issue May 7, 2023
@zacharyrperales
Add documentation for url key
b609d70 
References #14
zacharyrperales added a commit that referenced this issue May 7, 2023
@zacharyrperales
Add documentation
3ca39c8 
References #14
zacharyrperales added a commit that referenced this issue May 7, 2023
@zacharyrperales
Add inline documentation
e59a53d 
References #14
zacharyrperales added a commit that referenced this issue May 7, 2023
@zacharyrperales
Add documentation for dockerize command
4924d98 
References #14
zacharyrperales added a commit that referenced this issue May 7, 2023
@zacharyrperales
Add documentation for Docker Compose file
cb923b1 
References #14
zacharyrperales added a commit that referenced this issue May 7, 2023
@zacharyrperales
Edit grammar, include punctuation, add filename, add summary of file
b6eb92e 
References #14
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@zacharyrperales zacharyrperales

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

When branches are created from issues, their pull requests are automatically linked.

14-refactor-add-documentation-and-enforce-type-hints zacharyrperales/Scraper
1 participant
@zacharyrperales