DOCUMENTATION: Clarify "completion" property of GraftingTask (bitburn…

…er-official#1713)
catloversg · Oct 22, 2024 · b72c03a · b72c03a
1 parent 3ce2ae5
commit b72c03a
Show file tree

Hide file tree

Showing 3 changed files with 11 additions and 5 deletions.
diff --git a/markdown/bitburner.graftingtask.md b/markdown/bitburner.graftingtask.md
@@ -4,7 +4,7 @@
 
 ## GraftingTask interface
 
-Faction Work
+Grafting Work
 
 **Signature:**
 
@@ -14,7 +14,9 @@ export interface GraftingTask
 
 ## Remarks
 
-An object representing the current grafting status
+An object representing the current grafting task
+
+The "completion" property is a promise that resolves when the task is complete.
 
 ## Properties
 

diff --git a/markdown/bitburner.md b/markdown/bitburner.md
@@ -85,7 +85,7 @@
 |  [GoAnalysis](./bitburner.goanalysis.md) | Tools to analyze the IPvGO subnet. |
 |  [GoCheat](./bitburner.gocheat.md) | Illicit and dangerous IPvGO tools. Not for the faint of heart. Requires BitNode 14.2 to use. |
 |  [Grafting](./bitburner.grafting.md) | Grafting API |
-|  [GraftingTask](./bitburner.graftingtask.md) | Faction Work |
+|  [GraftingTask](./bitburner.graftingtask.md) | Grafting Work |
 |  [HackingFormulas](./bitburner.hackingformulas.md) | Hacking formulas |
 |  [HackingMultipliers](./bitburner.hackingmultipliers.md) | Hack related multipliers. |
 |  [Hacknet](./bitburner.hacknet.md) | Hacknet API |

diff --git a/src/ScriptEditor/NetscriptDefinitions.d.ts b/src/ScriptEditor/NetscriptDefinitions.d.ts
@@ -1708,9 +1708,13 @@ export interface FactionWorkTask {
 }
 
 /**
- * Faction Work
+ * Grafting Work
+ *
  * @remarks
- * An object representing the current grafting status
+ * An object representing the current grafting task
+ *
+ * The "completion" property is a promise that resolves when the task is complete.
+ *
  * @public
  */
 export interface GraftingTask {