Merge pull request #24 from UBC-MDS/yhouyang02-patch-1

Rename score.py to get_score.py and update comments

Author: yhouyang02

README.md

@@ -5,7 +5,7 @@
 | Package | [![Latest PyPI Version](https://img.shields.io/pypi/v/wordguess.svg)](https://pypi.org/project/wordguess/) [![Supported Python Versions](https://img.shields.io/pypi/pyversions/wordguess.svg)](https://pypi.org/project/wordguess/)  |
 | Meta   | [![Code of Conduct](https://img.shields.io/badge/Contributor%20Covenant-v2.0%20adopted-ff69b4.svg)](CODE_OF_CONDUCT.md) |
 
-wordguess is a project that contains essential functions for a word-guessing game, inspired by Wordle.
+Wordguess is a project that contains essential functions for a word-guessing game, inspired by Wordle.
 
 ## Summary
 The `wordguess` package is designed for developers to create guessing games. The package provides functionality for word validation, feedback generation, corpus management. It can compare user guesses to the target word and provide feedback on the accuracy of the guesses in terms of correct letters and their positions including numerical and human readable expressions. Additionally, features for scoring and hinting are included to enhance development of word guessing games. `wordguess` provides the back-end foundation needed to handle the underlying string comparisons and state tracking.
@@ -72,7 +72,7 @@ To use wordguess in your code:
     * **result** (*str*): A string of 0s, 1s, and 2s.
   * **Returns:** (*str*) A visual string of emojis (e.g., 🟩, 🟨, ⬛).
 
-## Key Definitions
+## Key definitions
 
 To ensure consistency for **users** (developers) and **players** (end-users), the following terminology is used throughout the package:
 

src/wordguess/score.py src/wordguess/get_score.pysrc/wordguess/score.py renamed to src/wordguess/get_score.py

@@ -1,6 +1,6 @@
-# score.py
-# author: Harry Yau
-# date 2026-01-09
+# get_score.py
+# Author: Harry Yau
+# Date: 2026-01-09
 
 def get_score(result: list[str], penalty: bool = False, penalty_rate: float = 0.0) -> float:
     """
@@ -10,7 +10,7 @@ def get_score(result: list[str], penalty: bool = False, penalty_rate: float = 0.
     The calculation will be the highest score from the result list.
     each guess will contain characters '0', '1', and '2' representing different guess outcomes.
     
-    calculation will be sum of of the highest guess score diveded by the total score of the words.
+    Calculation will be sum of of the highest guess score diveded by the total score of the words.
     for example, if the highest guess score is "12222"
     the returning score will be (1+2+2+2+2)/10 * 100 = 90.0
 
@@ -50,4 +50,4 @@ def get_score(result: list[str], penalty: bool = False, penalty_rate: float = 0.
     90.0
 
     """
-    ...
+    ...