refactored code to hold less dead code. updated Cargo.toml to ver. 0.2.0

3 files changed, 7 insertions, 6 deletions

diff --git a/Cargo.lock b/Cargo.lock
index d64c467..415e7fc 100644
--- a/Cargo.lock
+++ b/Cargo.lock
@@ -63,7 +63,7 @@ dependencies = [
 
 [[package]]
 name = "rs-snakesandladders"
-version = "0.1.0"
+version = "0.2.0"
 dependencies = [
  "rand",
 ]
diff --git a/Cargo.toml b/Cargo.toml
index ac9ea28..4a6cae7 100644
--- a/Cargo.toml
+++ b/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "rs-snakesandladders"
-version = "0.1.0"
+version = "0.2.0"
 edition = "2021"
 
 [dependencies]
diff --git a/src/main.rs b/src/main.rs
index 26d9e8c..7ccac12 100644
--- a/src/main.rs
+++ b/src/main.rs
@@ -43,6 +43,7 @@ impl Player {
     }
 }
 
+/// Plays a single turn for the given player by rolling the dice, checking for overshooting the goal, handling snakes/ladders, and recording the new position. Returns the updated player state after the turn.
 fn turn(mut player: Player) -> Player {
     player.turns += 1;
 
@@ -51,7 +52,7 @@ fn turn(mut player: Player) -> Player {
     // play 1 turn
     player.current_space = roll(player.current_space, name);
 
-    // check if the user has won
+    // added new goal logic in the main function
     // play = player_1.current_space != GOAL;
 
     player.current_space = check_over_goal(player.current_space);
@@ -62,6 +63,7 @@ fn turn(mut player: Player) -> Player {
     player
 }
 
+// Rolls the dice and returns the new space the player is on.
 fn roll(mut space: u8, name: String) -> u8 {
     let mut rng: rand::rngs::ThreadRng = rand::thread_rng();
 
@@ -76,6 +78,7 @@ fn roll(mut space: u8, name: String) -> u8 {
     space
 }
 
+// Checks if the player has gone over the goal and returns the new space.
 fn check_over_goal(mut space: u8) -> u8 {
     if space > 100 {
         // checks if the player has gone over the goal
@@ -91,6 +94,7 @@ fn check_over_goal(mut space: u8) -> u8 {
     space
 }
 
+// Checks if the player has moved to a new space and returns the new space.
 fn check_movement(mut space: u8) -> u8 {
     // converts the space into an index and 'usize' type
     let space_index: usize = (space - 1) as usize;
@@ -116,9 +120,6 @@ fn check_movement(mut space: u8) -> u8 {
 }
 
 fn main() {
-    // define variables
-    // let mut play: bool = true;
-
     let mut players: Vec<Player> = Vec::new();
 
     println!("Snakes & Ladders\n");