Skip to content

solutions_style_guide.md

Latest commit

 

History

History
8 lines (6 loc) · 943 Bytes

solutions_style_guide.md

File metadata and controls

8 lines (6 loc) · 943 Bytes

Solutions Style Guide

Submitted solutions need to conform to the following standards:

  • Code needs to meet pep8 standards. If your editor of choice doesn't check your code for you, you can pip install pep8, then run pep8 <filename>.py from the command line to check your code meets pep8 standards.
  • Documentation needs to meet pep257 standards. You can pip install pep257, then run pep257 <filename>.py from the command line to check your documentation meets pep257 standards.
  • Docstrings need to conform to NumPy/SciPy/sklearn conventions.
  • Solutions should be submitted in a module with a filename that matches that section of questions. For example, solutions for the General Programming questions should be submitted in a file named general_programming.py.