From afe6a837c36be43c2efa9d21f398759e8c13f2d3 Mon Sep 17 00:00:00 2001
From: Duck McSouls <quacksouls@gmail.com>
Date: Mon, 10 Oct 2022 20:49:33 +1100
Subject: [PATCH] DOC: `ns.sleeve.setToCommitCrime()`: add 1 example

An example on how to set a sleeve to commit a crime.  The example shows that sleeves are indexed from 0.
---
 src/ScriptEditor/NetscriptDefinitions.d.ts | 21 +++++++++++++++++++++
 1 file changed, 21 insertions(+)

diff --git a/src/ScriptEditor/NetscriptDefinitions.d.ts b/src/ScriptEditor/NetscriptDefinitions.d.ts
index 9a5d72c33..15a6aaeb5 100644
--- a/src/ScriptEditor/NetscriptDefinitions.d.ts
+++ b/src/ScriptEditor/NetscriptDefinitions.d.ts
@@ -3635,6 +3635,27 @@ export interface Sleeve {
    * - Shoplift
    * - Traffick arms
    *
+   * @example
+   * ```ts
+   * // NS1
+   * // Assign the first 3 sleeves to commit various crimes.
+   * var crime = ["mug", "rob store", "shoplift"];
+   * for (var i = 0; i < crime.length; i++) {
+   *     tprintf("Sleeve %d commits crime: %s", i, crime[i]);
+   *     sleeve.setToCommitCrime(i, crime[i]);
+   * }
+   * ```
+   * @example
+   * ```ts
+   * // NS2
+   * // Assign the first 3 sleeves to commit various crimes.
+   * const crime = ["mug", "rob store", "shoplift"];
+   * for (let i = 0; i < crime.length; i++) {
+   *     ns.tprintf("Sleeve %d commits crime: %s", i, crime[i]);
+   *     ns.sleeve.setToCommitCrime(i, crime[i]);
+   * }
+   * ```
+   *
    * @param sleeveNumber - Index of the sleeve to start committing crime. Sleeves are numbered starting from 0.
    * @param name - Name of the crime. Must be an exact match. Refer to the list of crimes.
    * @returns True if this action was set successfully, false otherwise.