📝 Add docstrings to feature/seed-substitute-players

Docstrings generation was requested by @nanotaboada.

* #334 (comment)

The following files were modified:

* `scripts/run-migrations-and-copy-database.sh`
* `src/Dotnet.Samples.AspNetCore.WebApi/Utilities/PlayerData.cs`

Author: coderabbitai[bot]

scripts/run-migrations-and-copy-database.sh

@@ -8,6 +8,8 @@ PROJECT_BASE_PATH="$PROJECT_ROOT_PATH/bin/Debug/net8.0"
 SOURCE_FILE_PATH="$PROJECT_BASE_PATH/storage/$DATA_FILE"
 TARGET_FILE_PATH="$PROJECT_ROOT_PATH/storage/$DATA_FILE"
 
+# log prints a formatted log message prefixed by an emoji and timestamp, followed by the log level and message.
+# Parameters: emoji — emoji or symbol to prefix the entry; level — severity or level label; message — the log text.
 log() {
     local emoji=$1
     local level=$2
@@ -60,4 +62,4 @@ if [ -f "$TARGET_FILE_PATH" ]; then
 else
     log "⚠️" "WARNING" "Something went wrong. The destination file was not found."
     exit 1
-fi
+fi

src/Dotnet.Samples.AspNetCore.WebApi/Utilities/PlayerData.cs

@@ -1,4 +1,4 @@
-using System.Text.Json;
+using System.Text.Json;
 using Dotnet.Samples.AspNetCore.WebApi.Enums;
 using Dotnet.Samples.AspNetCore.WebApi.Models;
 
@@ -153,6 +153,10 @@ public static List<Player> MakeStarting11()
         ];
     }
 
+    /// <summary>
+    /// Create a predefined starting eleven of players where each player has a fixed GUID identifier and full profile data.
+    /// </summary>
+    /// <returns>A list of 11 Player instances representing the starting lineup; each entry includes a predefined Id (Guid) and populated fields such as name, date of birth, squad number, position (and abbreviation), team, league, and Starting11 set to true.</returns>
     public static List<Player> MakeStarting11WithId()
     {
         return
@@ -311,6 +315,10 @@ public static List<Player> MakeStarting11WithId()
         ];
     }
 
+    /// <summary>
+    /// Creates a predefined list of substitute Player objects with their properties populated and Starting11 set to false.
+    /// </summary>
+    /// <returns>A List&lt;Player&gt; containing sample substitute players. Each entry is populated with player details but does not include an Id value.</returns>
     public static List<Player> GetSubstitutes()
     {
         return
@@ -510,6 +518,10 @@ public static List<Player> GetSubstitutes()
         ];
     }
 
+    /// <summary>
+    /// Creates a predefined list of substitute players, each populated with a specific GUID Id and player metadata.
+    /// </summary>
+    /// <returns>A List&lt;Player&gt; containing substitute players with Starting11 set to false and explicit Id values.</returns>
     public static List<Player> GetSubstitutesWithId()
     {
         return
@@ -881,4 +893,4 @@ public static List<Player> MakeStarting11FromDeserializedJson()
 
     private static readonly JsonSerializerOptions options =
         new() { PropertyNameCaseInsensitive = true };
-}
+}