docstring for grantAchievement (#1785)

See #1751 (comment)
swarm-game · Mar 6, 2024 · 3f2a8fd · 3f2a8fd
1 parent 936b30d
commit 3f2a8fd
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/src/swarm-engine/Swarm/Game/Step/Util/Command.hs b/src/swarm-engine/Swarm/Game/Step/Util/Command.hs
@@ -152,6 +152,8 @@ onTarget rid act = do
               then deleteRobot rid
               else robotMap . ix rid .= tgt'
 
+-- | Enforces validity of the robot's privileged status to receive
+-- an achievement.
 grantAchievementForRobot ::
   (HasRobotStepState sig m, Has (Lift IO) sig m) =>
   GameplayAchievement ->
@@ -174,6 +176,8 @@ checkGameModeAchievementValidity a = do
  where
   ValidityConditions _ gameplayModeRequired = getValidityRequirements a
 
+-- | NOTE: When possible, one should use the
+-- 'grantAchievementForRobot' function instead of this one.
 grantAchievement ::
   (Has (State GameState) sig m, Has (Lift IO) sig m) =>
   GameplayAchievement ->