Mercurial > public > m209
comparison 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 |
comparison
equal
deleted
inserted
replaced
66:590a03d6eb6b | 67:a2647b9fe107 |
---|---|
14 | 14 |
15 The ``M209`` class takes the following optional arguments. | 15 The ``M209`` class takes the following optional arguments. |
16 | 16 |
17 :param lugs: either a lug settings list or string as per :meth:`set_drum_lugs` | 17 :param lugs: either a lug settings list or string as per :meth:`set_drum_lugs` |
18 :param pin_list: a list of six strings each formatted as per :ref:`pin-settings` | 18 :param pin_list: a list of six strings each formatted as per :ref:`pin-settings` |
19 | |
20 ``M209`` objects have the following attributes. | |
21 | |
22 .. attribute:: letter_count | |
23 | |
24 This attribute represents the *letter counter* functionality. It is an | |
25 integer that is incremented after every letter is encrypted or decrypted. | |
26 It may be set to any integer value or examined at any time. | |
19 | 27 |
20 ``M209`` objects support the following methods. | 28 ``M209`` objects support the following methods. |
21 | 29 |
22 .. method:: set_pins(n, effective_pins) | 30 .. method:: set_pins(n, effective_pins) |
23 | 31 |