Commit 4aa4cc5f authored by Éamonn Murray's avatar Éamonn Murray

Add more detail on code requirements

parent 5c8a0521
......@@ -33,7 +33,7 @@ Set Up
- Each assignment will be contained within its own folder: `Assignment1`,
`Assignment2`, `Assignment3` and `Assignment4`.
- As you create the files required for the assignment you should add them to
your git repo and push the changes to the gitlab repo.
your local git repo and push the changes to the remote gitlab repo.
- I will automatically download a copy of your gitlab repository at the
assignment deadline for grading.
......@@ -46,6 +46,14 @@ Assignments
files suffixed as `.py` and conforming to the Python 3 standard, and
beginning with the line `#!/usr/bin/env python3`. You should **not** submit
jupyter notebooks unless specifically requested.
- Please test your code, and functions individually.
- To allow automatic testing, and importing of functions from modules you
write please ensure:
- Any code intended to be run when the python script is executed is
contained within a `main()` function that is called with the usual
[boilerplate](../python1/README.md#boilerplate-modules-and-using-a-main-function).
- Functions do not produce plot or print output *by default* unless
specifically requested.
- Python code should follow [the PEP8 style
guide](https://www.python.org/dev/peps/pep-0008/) as much as possible. Your
code should be properly commented. Functions should have docstrings that
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment