From 5543b8a3c412b71ac2ade08eedc8be9fffa4eeaa Mon Sep 17 00:00:00 2001
From: Leonard Jonathan Oh <leonardjonathanoh@live.com>
Date: Sat, 16 Sep 2023 10:38:17 +0000
Subject: [PATCH] Improve script param comments

---
 Generate-GitBranches.ps1 | 19 +++++++++++++++----
 1 file changed, 15 insertions(+), 4 deletions(-)

diff --git a/Generate-GitBranches.ps1 b/Generate-GitBranches.ps1
index 53af5807..81f3f929 100644
--- a/Generate-GitBranches.ps1
+++ b/Generate-GitBranches.ps1
@@ -2,13 +2,24 @@
 # 2. By default it creates a git branch for each game found in games.json. To limit to one game, specify -GamePlatform, -GameEngine, and -Game
 # 3. To build a game, checkout to its branch, edit .env, mutate .trigger, commit and push
 # Examples:
+#   # Create branches for all games
 #   ./ Generate-GitBranches.ps1 -TargetRepoPath <path> -Pull
+#   # Create branches for specific game
 #   ./ Generate-GitBranches.ps1 -TargetRepoPath <path> -Pull -GamePlatform steam -GameEngine srcds -Game csgo
 param(
-    [string]$TargetRepoPath, # Target repo path
-    [switch]$Pull, # Whether to pull changes from remote repo before creating / updating branches
-    [string]$GamePlatform,
-    [string]$GameEngine,
+    # Target repo path
+    [string]$TargetRepoPath
+,
+    # Whether to pull changes from remote repo before creating / updating branches
+    [switch]$Pull
+,
+    # E.g. 'steam'
+    [string]$GamePlatform
+,
+    # E.g. 'hlds' or 'srcds'
+    [string]$GameEngine
+,
+    # E.g. 'cstrike'
     [string]$Game
 )
 Set-StrictMode -Version Latest