Browse Source

Documenting speeds

Matt Sparks 13 years ago
parent
commit
82f40a10e1
1 changed files with 22 additions and 1 deletions
  1. 22 1
      alphasign/speeds.py

+ 22 - 1
alphasign/speeds.py

@@ -1,6 +1,27 @@
+"""
+The following constants are defined to change speeds in TEXT
+(:class:`alphasign.text.Text`) files:
+
+* :const:`SPEED_1` (slowest)
+* :const:`SPEED_2`
+* :const:`SPEED_3`
+* :const:`SPEED_4`
+* :const:`SPEED_5` (fastest)
+
+--------
+Examples
+--------
+
+Make a text file with fast text::
+
+  msg = alphasign.Text("%sthis text is fast" % alphasign.speeds.SPEED_5,
+                       label="A",
+                       mode=alphasign.modes.ROTATE)
+"""
+
 # Display speeds
 SPEED_1 = "\x15"
 SPEED_2 = "\x16"
 SPEED_3 = "\x17"
 SPEED_4 = "\x18"
-SPEED_5 = "\x19"
+SPEED_5 = "\x19"