Skip to content

Commit 284f661

Browse files
committed
Revise documentation
1 parent eeeb329 commit 284f661

File tree

1 file changed

+4
-2
lines changed

1 file changed

+4
-2
lines changed

Diff for: smp.py

+4-2
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,8 @@ def proposeTo(self, other):
3131
def choose(self, choice):
3232
"""
3333
Say 'maybe' to other Person. Say 'no' to everyone else. Clears the set
34-
of proposals, and removes self from the prefs of everyone that was rejected.
34+
of proposals, and removes self from the available options for everyone
35+
that was rejected.
3536
"""
3637
self.choice = choice
3738
choice.choice = self
@@ -144,7 +145,8 @@ def randomPreferences(n):
144145
Gets a random ordering of preferences for each boy and girl in an instance
145146
of the stable marriage problem for given n.
146147
147-
Due to the naming of the girls, n must be <= 26.
148+
Args:
149+
n: the number of boys and girls. Must be <= 26.
148150
"""
149151
if n > 26: raise ValueError()
150152

0 commit comments

Comments
 (0)