doc tweaks

data/scenarios/Testing/836-pathfinding/836-automatic-waypoint-navigation.yaml

@@ -45,7 +45,7 @@ entities:
       char: 'o'
       attr: easter_egg
     description:
-      - Just the flower top of the plant
+      - A colorful egg laid by the rabbit
     properties: [known, portable]
     growth: [5, 10]
 robots:
@@ -66,6 +66,7 @@ robots:
       - treads
       - wayfinder
   - name: gardener
+    description: Periodically chops down the kudzu plant
     dir: [1, 0]
     system: true
     devices:
@@ -109,7 +110,7 @@ world:
     '─': [stone, horizontal wall]
     '│': [stone, vertical wall]
   structures:
-    - name: bigbox
+    - name: cornerbox
       structure:
         palette:
           '.': [dirt]
@@ -123,19 +124,19 @@ world:
           @w.
           @.@
   placements:
-    - src: bigbox
+    - src: cornerbox
       offset: [2, -2]
       orient:
         up: north
-    - src: bigbox
+    - src: cornerbox
       offset: [8, -2]
       orient:
         up: east
-    - src: bigbox
+    - src: cornerbox
       offset: [8, -6]
       orient:
         up: south
-    - src: bigbox
+    - src: cornerbox
       offset: [2, -6]
       orient:
         up: west

data/schema/robot.json

@@ -11,9 +11,8 @@
             "description": "The name of the robot. This shows up in the list of robots in the game (F2), and is also how the robot will be referred to in the world palette."
         },
         "description": {
-            "default": [],
             "type": "string",
-            "description": "A description of the robot, given as a list of paragraphs. This is currently not used for much (perhaps not at all?)."
+            "description": "A description of the robot. This is currently not used for much, other than scenario documentation."
         },
         "loc": {
             "description": "An optional starting location for the robot. If the loc field is specified, then a concrete robot will be created at the given location. If this field is omitted, then this robot record exists only as a template which can be referenced from a cell in the world palette. Concrete robots will then be created wherever the corresponding palette character is used in the world map.",

src/Swarm/Game/Step/Pathfinding.hs

@@ -14,11 +14,11 @@
 --
 -- Instead, in the current implementation a complete path is computed
 -- internally upon invoking the @path@ command, and just the direction of the
--- first "move" along that path is returned as a result to the callee.
+-- first "move" along that path is returned as a result to the caller.
 --
 -- == Max distance
 --
--- We allow the callee to supply a max distance, but also impose an internal maximum
+-- We allow the caller to supply a max distance, but also impose an internal maximum
 -- distance to prevent programming errors from irrecoverably freezing the game.
 module Swarm.Game.Step.Pathfinding where
 
@@ -48,7 +48,7 @@ data PathfindingTarget
     EntityTarget EntityName
 
 -- | swarm command arguments are converted to idiomatic Haskell
--- types before invoking this function, and conversely the callee
+-- types before invoking this function, and conversely the callsite
 -- is also responsible for translating the output type to a swarm value.
 --
 -- The cost function is uniformly @1@ between adjacent cells.