Skip to content

Commit 8108cf1

Browse files
committed
modified some documentation
1 parent d22822e commit 8108cf1

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

pycuber/formula.py

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
"""
22
3-
This module is to implement the Rubik's Cube algorithms.
4-
You can deal with Rubik's Cube algorithms easily with Step and Formula.
3+
This module is to implement the Rubik's Cube formulae.
4+
You can deal with Rubik's Cube formulae easily with Step and Formula.
55
66
Usage:
77
>>> a = Formula("R U R' U'")
@@ -266,7 +266,7 @@ def __hash__(self):
266266
class Formula(list):
267267

268268
"""
269-
Representing a Rubik's Cube algorithm.
269+
Representing a Rubik's Cube formula.
270270
271271
>>> a = Formula("R U R' U'")
272272
>>> a
@@ -719,7 +719,7 @@ def _optimise_same_steps(self, is_root=True):
719719

720720
def optimise(self):
721721
"""
722-
Optimize the algorithm:
722+
Optimize the formula:
723723
- Only outer layers (LUFDRB)
724724
- No cube rotations (x y z)
725725
- No repeated steps
@@ -769,7 +769,7 @@ def random(self, n=25, clear=True):
769769

770770
def mirror(self, direction="LR"):
771771
"""
772-
Mirror the algorithm.
772+
Mirror the formula.
773773
774774
>>> a = Formula("R U R' U'")
775775
>>> a.mirror()

0 commit comments

Comments
 (0)