Commits

Cédric Bonhomme committed ab03d83

- Updated documentation of the Enigma class;
- Reorder arguments (rotors).

Comments (0)

Files changed (1)

pyenigma/enigma.py

 class Enigma(object):
     """
     Represents an Enigma machine.
+    Initializes an Enigma machine with these arguments:
+    - ref: reflector;
+    - r1, r2, r3: rotors;
+    - key: initial state of rotors;
+    - plus: plugboard settings.
     """
-    def __init__(self, ref, r3, r2, r1, key="AAA", plugs="", ringset=1):
+    def __init__(self, ref, r1, r2, r3, key="AAA", plugs="", ringset=1):
         """
         Initialization of the Enigma machine.
         """
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.