Add a general info docstring to compass example.

willingc · dpgeorge · commit 31c0259a5392 · 2015-11-01T23:10:53.000Z
diff --git a/examples/compass.py b/examples/compass.py
@@ -1,7 +1,16 @@
+"""
+    compass.py
+    ~~~~~~~~~~
+
+    Creates a compass.
+
+    To calibrate the compass, lay it flat and spin it horizontally. For best
+    results during calibration, try not to tilt the compass up and down.
+"""
 from microbit import *
 
 needles = (Image.CLOCK12, Image.CLOCK1, Image.CLOCK2, Image.CLOCK3,
-           Image.CLOCK4, Image.CLOCK5, Image.CLOCK6, Image.CLOCK7, 
+           Image.CLOCK4, Image.CLOCK5, Image.CLOCK6, Image.CLOCK7,
            Image.CLOCK8, Image.CLOCK9, Image.CLOCK10, Image.CLOCK11)
 
 # You need to spin the microbit about a few times to help calibrate the compass
