CS 115 Project 2 Style Grading Sheet
Programming Style (35 points)
Docstring (3 points)
| [3] | There is a docstring at the top of the submitted file with
your name (first and last), the course (CS 115) and assignment (Project 2), and a brief description of the
program. |
| -1 | Missing name |
| -1 | Missing or wrong course and/or assignment |
| -1 | Missing or wrong description |
Usage of functions (5 points)
| [5] | Program is broken up into logical, well-defined functions.
Functions perform specific, well-defined jobs and have descriptive names.
Functions are no more than 20 lines of code. |
| -1 | Minor lapses |
| -3 | Major flaws |
| -5 | Program does not have student-written functions |
Function parameters and return values (5 points)
| [5] | Functions have no more parameters than necessary to do their jobs.
Return values are used appropriately. |
| -2 | Minor flaws |
| -4 | Major flaws |
| -5 | Program does not have student-written functions |
Function documentation (5 points)
| [5] |
Each function includes a docstring explaining the job it does, its input parameters,
its return value, and any assumptions it makes about its inputs. See drift_graphics.py for examples. |
| -2 | Minor lapses |
| -3 | Some functions do not have comments |
| -5 | Most functions do not have comments |
Other documentation (6 points)
Not counting the docstrings for your program and functions, your program should contain at least three comments
explaining aspects of your code that are potentially tricky for a person reading it
to understand. You should assume that the person understands what Python syntax means
but may not understand why you are doing what you are doing.
| 6 pts. | You have at least 3 useful comments (2 point each) |
Variable declarations and naming (5 points)
| [5] | All variables have descriptive names that indicate what they
are used for |
| -2 | Variable declarations uncommented |
| -3 | Variable names do not indicate what the variable is used for |
Algorithm (6 points)
| 3 pts. | Your algorithm is straightforward and easy to follow. |
| 3 pts. | Your algorithm is reasonably efficient, with no wasted computation or unused variables. |
Catchall
You will lose 5 points for having ANY statements outside of a function definition. There are
only three exceptions to this rule:
- Import statements
- Declaration of constants (variables whose values are never modified again)
- The call to main
For students using language features that were not covered in class, up to 5 points may be taken off if the principles of programming style
are not adhered to when using these features. If you have any questions about what this means, ASK!