diff docs/m209.rst @ 67:a2647b9fe107

Documented the M209's letter_count attribute.
author Brian Neal <bgneal@gmail.com>
date Sat, 20 Jul 2013 19:13:41 -0500
parents 256b3f3e35e9
children 2173ac4c2d9b
line wrap: on
line diff
--- a/docs/m209.rst	Sat Jul 20 18:53:39 2013 -0500
+++ b/docs/m209.rst	Sat Jul 20 19:13:41 2013 -0500
@@ -17,6 +17,14 @@
   :param lugs: either a lug settings list or string as per :meth:`set_drum_lugs`
   :param pin_list: a list of six strings each formatted as per :ref:`pin-settings`
 
+``M209`` objects have the following attributes.
+
+   .. attribute:: letter_count
+
+      This attribute represents the *letter counter* functionality. It is an
+      integer that is incremented after every letter is encrypted or decrypted.
+      It may be set to any integer value or examined at any time.
+
 ``M209`` objects support the following methods.
 
    .. method:: set_pins(n, effective_pins)