Skip to content

Commit 5cd1702

Browse files
author
cclauss
committed
Update README.md to for Class-based implementation
1 parent cf3be2b commit 5cd1702

File tree

1 file changed

+6
-5
lines changed

1 file changed

+6
-5
lines changed

README.md

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,10 @@
1-
High Scores
2-
===========
1+
HighScores
2+
==========
33

44
High Scores module for Python.
55
By Tj Ferry.
66

7-
This module currently supports two main public functions:
8-
+ `is_high_score(username, score)` will return True if this is the first score or the highest score for this user. Otherwise False will be returned. The `score` parameter should be numeric (int, long, float, etc.) and NOT a string.
9-
+ `print_scores()` prints out a formatted list of all users with their high scores
7+
This module contains a HighScores class that supports three main public methods:
8+
+ `__init__([file_name])` which takes an optional name for the file used to record the high scores.
9+
+ `is_high_score(username, score)` will return True if this is the first score or the highest score for this user. Otherwise, False will be returned. The `score` parameter should be numeric (int, long, float, etc.) and NOT a string.
10+
+ `print_scores()` prints out a sorted, formatted list of all users with their high scores

0 commit comments

Comments
 (0)