Coding Guidelines for Submitted Code
All code submitted for a grade in DSC 140S: Fundamentals of Data Science must contain the following elements:
- All function names and variables names must be short but descriptive. Exceptions to this are allowed where there is a typical programming convention such as using
n
to represent the length of a list or usingi
in a for loop to iterate through the indices of a list. - All blocks of code must contain a descriptive comment that describes what the code does. This does not mean you need to include a comment for every line of code, but for sections of code that are used to accomplish a single tasks you could create a comment for that section.
- All functions must have a docstring which includes a description of the function, a list and description of all arguments, and a list and description of all returned values.