docs(commands): add examples for ADDWPT, WIND, SPD, ALT, DEFWPT

Author: abc8747

packages/minisky/minisky/_internal/autopilot.py

@@ -1151,7 +1151,7 @@ def set_airspeed_for_rta(
             self.traffic.actwp.airspeed.kind[idx] = OptionalAirspeedKind.NONE
         return None
 
-    @command(name="ALT")
+    @command(name="ALT", examples=("ALT KL204 FL200 1500FT/MIN",))
     def selaltcmd(
         self, idx: AcIdSelection, alt: StdPressureAltM[IsFinite[float]], vspd: VspdMps | None = None
     ) -> Result[str, str]:
@@ -1233,7 +1233,11 @@ def selhdgcmd(
         self.traffic.swlnav[idx] = False
         return Ok(f"heading set to {resolved_hdg} deg")
 
-    @command(name="SPD", aliases=("SPEED",))
+    @command(
+        name="SPD",
+        aliases=("SPEED",),
+        examples=("SPD KL204 250KT[CAS]", "SPD KL204 M0.78"),
+    )
     def select_airspeed(
         self,
         idx: AcIdSelection,

packages/minisky/minisky/_internal/command.py

@@ -592,6 +592,7 @@ def parse_omitted_field(
 
 _OMITTED_INPUT = _OmittedInput()
 Omitted = Annotated[OmittedField, CmdParser(parse_omitted_field, _OMITTED_INPUT)]
+# TODO(abraham): remove Omitted altogether (it's confusing)
 
 
 def parse_text(_context: CommandParseContext, cursor: CommandCursor) -> ParseResult[str]:

packages/minisky/minisky/_internal/navigation.py

@@ -203,7 +203,7 @@ def delete_from_scenario(
         """Delete a scenario-specific waypoint."""
         return self.delwpt(name)
 
-    @command(name="DEFWPT")
+    @command(name="DEFWPT", examples=("DEFWPT MYWPT 52.3 4.7",))
     def define_from_scenario(self, name: Keyword, position: LatLonDeg) -> Result[str, str]:
         """Define a scenario-specific waypoint from a position."""
         return self.defwpt(name, position.lat, position.lon)

packages/minisky/minisky/_internal/route.py

@@ -1541,7 +1541,7 @@ def add_waypoint_turn_heading_rate(
         """Set a fly-turn heading rate through ADDWPT, in degrees per second."""
         return _set_turn_heading_rate(self.traffic, acidx, value)
 
-    @command(name="ADDWPT")
+    @command(name="ADDWPT", examples=("ADDWPT KL204 TAKEOFF EHAM/RW06",))
     def add_takeoff_waypoint_from_runway(
         self,
         acidx: AcId,
@@ -1601,7 +1601,14 @@ def insert_waypoint_after(
             InsertAfter(after),
         )
 
-    @command(name="ADDWPT", aliases=("WPTYPE",))
+    @command(
+        name="ADDWPT",
+        aliases=("WPTYPE",),
+        examples=(
+            "ADDWPT KL204 SPL FL250 250KT[CAS]",
+            "ADDWPT KL204 RTM,,250KT[CAS]",
+        ),
+    )
     def append_waypoint(
         self,
         acidx: AcId,

packages/minisky/minisky/_internal/wind.py

@@ -389,7 +389,7 @@ def clear_wind(
         self.clear()
         return Ok("")
 
-    @command(name="WIND")
+    @command(name="WIND", examples=("WIND 52 4 270 20KT",))
     def set_constant_wind(
         self,
         position: LatLonDeg,
@@ -401,7 +401,7 @@ def set_constant_wind(
         self.addpoint(position.lat, position.lon, direction % 360.0, speed)
         return Ok("")
 
-    @command(name="WIND")
+    @command(name="WIND", examples=("WIND 52 4,,270 20KT",))
     def set_constant_wind_with_omitted_field(
         self,
         position: LatLonDeg,
@@ -413,7 +413,10 @@ def set_constant_wind_with_omitted_field(
         self.addpoint(position.lat, position.lon, direction % 360.0, speed)
         return Ok("")
 
-    @command(name="WIND")
+    @command(
+        name="WIND",
+        examples=("WIND 52 4 FL050 270 20KT FL100 300 30KT",),
+    )
     def set_wind_profile(
         self, position: LatLonDeg, first: WindLevel, *additional: WindLevel
     ) -> Result[str, str]: