Skip to content

Commit 8307285

Browse files
committed
Add docs
1 parent 02e39e6 commit 8307285

File tree

1 file changed

+18
-0
lines changed

1 file changed

+18
-0
lines changed

pycuber/formula.py

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -265,22 +265,40 @@ def __hash__(self):
265265

266266
@property
267267
def name(self):
268+
"""
269+
Name of the Step object (B', R, U2)
270+
"""
268271
return self.__name()
269272

270273
@property
271274
def is_counter_clockwise(self):
275+
"""
276+
True if direction is counter-clockwise (not including 180 degrees)
277+
False otherwise
278+
"""
272279
return self.__is_counter_clockwise()
273280

274281
@property
275282
def is_clockwise(self):
283+
"""
284+
True if direction is clockwise (not including 180 degrees)
285+
False otherwise
286+
"""
276287
return self.__is_clockwise()
277288

278289
@property
279290
def is_180(self):
291+
"""
292+
True if the action is to turn 180 degrees
293+
False otherwise
294+
"""
280295
return self.__is_180()
281296

282297
@property
283298
def face(self):
299+
"""
300+
Face of the step (R, U, l, x, M)
301+
"""
284302
return self.__face()
285303

286304

0 commit comments

Comments
 (0)