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

Add docstrings to all functions and clean up code #32

Open
5 tasks
Paulinakhew opened this issue Nov 28, 2019 · 0 comments
Open
5 tasks

Add docstrings to all functions and clean up code #32

Paulinakhew opened this issue Nov 28, 2019 · 0 comments
Assignees
@Paulinakhew
Labels
easy 😌 Super quick fix enhancement ✨ New feature or request

Comments

@Paulinakhew
Copy link
Owner

Paulinakhew commented Nov 28, 2019 •
edited
Loading

  • this issue just has to do with code readability
  • in the future, when building this out, each function should be properly labeled and its purpose should be easy to identify
  • this website has a lot of popular docstrings formats
  • Add docstrings to all functions in model.py
  • Add docstrings to all functions in controller.py
  • Add line separations within functions
  • remove unnecessary commented out code
  • implement flake8
@Paulinakhew Paulinakhew added enhancement ✨ New feature or request easy 😌 Super quick fix labels Nov 28, 2019
@Paulinakhew Paulinakhew self-assigned this Nov 28, 2019
Paulinakhew added a commit that referenced this issue Nov 28, 2019
@Paulinakhew
♻️ Clean up code and add docstrings
cea67b8 
 #32
@Paulinakhew Paulinakhew changed the title Add docstrings to all functions and remove comments Add docstrings to all functions and clean up code Nov 28, 2019
Paulinakhew added a commit that referenced this issue Dec 2, 2019
@Paulinakhew
🎨 Improve structure of functions
d04cd3b 
 #32
Paulinakhew added a commit that referenced this issue Dec 5, 2019
@Paulinakhew
♻️ Clean up code after installing linter
8ca08fe 
 #32
Paulinakhew added a commit that referenced this issue Dec 5, 2019
@Paulinakhew
♻️ Cleaning up code to adhere to flake8
c8034b8 
 #32
Paulinakhew added a commit that referenced this issue Jan 16, 2020
@Paulinakhew
🎨 Add docstrings to sell function
18cf867 
 #32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@Paulinakhew Paulinakhew

Labels
easy 😌 Super quick fix enhancement ✨ New feature or request
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@Paulinakhew