From 057aeaea8318b5d588b96f896e2f52a60f72b1e4 Mon Sep 17 00:00:00 2001
From: omuretsu <84951833+Snarling@users.noreply.github.com>
Date: Wed, 8 Mar 2023 01:39:05 -0500
Subject: [PATCH] Doc update

* Added notes about whether ns API layers contain spoilers.
* Add some more info to checkFactionInvitation doc
---
 markdown/bitburner.ns.bladeburner.md          |  2 +-
 markdown/bitburner.ns.corporation.md          |  7 ++++-
 markdown/bitburner.ns.gang.md                 |  2 +-
 markdown/bitburner.ns.grafting.md             |  2 +-
 markdown/bitburner.ns.hacknet.md              |  2 +-
 markdown/bitburner.ns.infiltration.md         |  7 ++++-
 markdown/bitburner.ns.md                      | 20 ++++++------
 markdown/bitburner.ns.singularity.md          |  7 ++++-
 markdown/bitburner.ns.sleeve.md               |  2 +-
 markdown/bitburner.ns.stanek.md               |  7 ++++-
 markdown/bitburner.ns.ui.md                   |  7 ++++-
 ...ner.singularity.checkfactioninvitations.md |  2 +-
 src/ScriptEditor/NetscriptDefinitions.d.ts    | 31 ++++++++++---------
 13 files changed, 62 insertions(+), 36 deletions(-)

diff --git a/markdown/bitburner.ns.bladeburner.md b/markdown/bitburner.ns.bladeburner.md
index c7d12efe7..8bb20ecc6 100644
--- a/markdown/bitburner.ns.bladeburner.md
+++ b/markdown/bitburner.ns.bladeburner.md
@@ -4,7 +4,7 @@
 
 ## NS.bladeburner property
 
-Namespace for bladeburner functions.
+Namespace for bladeburner functions. Contains spoilers.
 
 **Signature:**
 
diff --git a/markdown/bitburner.ns.corporation.md b/markdown/bitburner.ns.corporation.md
index 69f37cddd..fe5acf69d 100644
--- a/markdown/bitburner.ns.corporation.md
+++ b/markdown/bitburner.ns.corporation.md
@@ -4,10 +4,15 @@
 
 ## NS.corporation property
 
-Namespace for corporation functions. RAM cost: 1022.4 GB
+Namespace for corporation functions. Contains spoilers.
 
 **Signature:**
 
 ```typescript
 readonly corporation: Corporation;
 ```
+
+## Remarks
+
+RAM cost: 0 GB
+
diff --git a/markdown/bitburner.ns.gang.md b/markdown/bitburner.ns.gang.md
index a72442ec7..a7c1ed00c 100644
--- a/markdown/bitburner.ns.gang.md
+++ b/markdown/bitburner.ns.gang.md
@@ -4,7 +4,7 @@
 
 ## NS.gang property
 
-Namespace for gang functions.
+Namespace for gang functions. Contains spoilers.
 
 **Signature:**
 
diff --git a/markdown/bitburner.ns.grafting.md b/markdown/bitburner.ns.grafting.md
index 7c7bdbf6d..432de22de 100644
--- a/markdown/bitburner.ns.grafting.md
+++ b/markdown/bitburner.ns.grafting.md
@@ -4,7 +4,7 @@
 
 ## NS.grafting property
 
-Namespace for grafting functions.
+Namespace for grafting functions. Contains spoilers.
 
 **Signature:**
 
diff --git a/markdown/bitburner.ns.hacknet.md b/markdown/bitburner.ns.hacknet.md
index 7d211408b..12e54852a 100644
--- a/markdown/bitburner.ns.hacknet.md
+++ b/markdown/bitburner.ns.hacknet.md
@@ -4,7 +4,7 @@
 
 ## NS.hacknet property
 
-Namespace for hacknet functions.
+Namespace for hacknet functions. Some of this API contains spoilers.
 
 **Signature:**
 
diff --git a/markdown/bitburner.ns.infiltration.md b/markdown/bitburner.ns.infiltration.md
index 69c510826..07f76f3e6 100644
--- a/markdown/bitburner.ns.infiltration.md
+++ b/markdown/bitburner.ns.infiltration.md
@@ -4,10 +4,15 @@
 
 ## NS.infiltration property
 
-Namespace for infiltration functions. RAM cost: 0 GB
+Namespace for infiltration functions.
 
 **Signature:**
 
 ```typescript
 readonly infiltration: Infiltration;
 ```
+
+## Remarks
+
+RAM cost: 0 GB
+
diff --git a/markdown/bitburner.ns.md b/markdown/bitburner.ns.md
index c8e8c4362..e1406ef29 100644
--- a/markdown/bitburner.ns.md
+++ b/markdown/bitburner.ns.md
@@ -41,21 +41,21 @@ export async function main(ns) {
 |  Property | Modifiers | Type | Description |
 |  --- | --- | --- | --- |
 |  [args](./bitburner.ns.args.md) | <code>readonly</code> | (string \| number \| boolean)\[\] | Arguments passed into the script. |
-|  [bladeburner](./bitburner.ns.bladeburner.md) | <code>readonly</code> | [Bladeburner](./bitburner.bladeburner.md) | Namespace for bladeburner functions. |
+|  [bladeburner](./bitburner.ns.bladeburner.md) | <code>readonly</code> | [Bladeburner](./bitburner.bladeburner.md) | Namespace for bladeburner functions. Contains spoilers. |
 |  [codingcontract](./bitburner.ns.codingcontract.md) | <code>readonly</code> | [CodingContract](./bitburner.codingcontract.md) | Namespace for codingcontract functions. |
-|  [corporation](./bitburner.ns.corporation.md) | <code>readonly</code> | [Corporation](./bitburner.corporation.md) | Namespace for corporation functions. RAM cost: 1022.4 GB |
+|  [corporation](./bitburner.ns.corporation.md) | <code>readonly</code> | [Corporation](./bitburner.corporation.md) | Namespace for corporation functions. Contains spoilers. |
 |  [enums](./bitburner.ns.enums.md) |  | [NSEnums](./bitburner.nsenums.md) |  |
 |  [formulas](./bitburner.ns.formulas.md) | <code>readonly</code> | [Formulas](./bitburner.formulas.md) | Namespace for formulas functions. |
-|  [gang](./bitburner.ns.gang.md) | <code>readonly</code> | [Gang](./bitburner.gang.md) | Namespace for gang functions. |
-|  [grafting](./bitburner.ns.grafting.md) | <code>readonly</code> | [Grafting](./bitburner.grafting.md) | Namespace for grafting functions. |
-|  [hacknet](./bitburner.ns.hacknet.md) | <code>readonly</code> | [Hacknet](./bitburner.hacknet.md) | Namespace for hacknet functions. |
-|  [infiltration](./bitburner.ns.infiltration.md) | <code>readonly</code> | [Infiltration](./bitburner.infiltration.md) | Namespace for infiltration functions. RAM cost: 0 GB |
+|  [gang](./bitburner.ns.gang.md) | <code>readonly</code> | [Gang](./bitburner.gang.md) | Namespace for gang functions. Contains spoilers. |
+|  [grafting](./bitburner.ns.grafting.md) | <code>readonly</code> | [Grafting](./bitburner.grafting.md) | Namespace for grafting functions. Contains spoilers. |
+|  [hacknet](./bitburner.ns.hacknet.md) | <code>readonly</code> | [Hacknet](./bitburner.hacknet.md) | Namespace for hacknet functions. Some of this API contains spoilers. |
+|  [infiltration](./bitburner.ns.infiltration.md) | <code>readonly</code> | [Infiltration](./bitburner.infiltration.md) | Namespace for infiltration functions. |
 |  [pid](./bitburner.ns.pid.md) | <code>readonly</code> | number | The current script's PID |
-|  [singularity](./bitburner.ns.singularity.md) | <code>readonly</code> | [Singularity](./bitburner.singularity.md) | Namespace for singularity functions. RAM cost: 0 GB |
-|  [sleeve](./bitburner.ns.sleeve.md) | <code>readonly</code> | [Sleeve](./bitburner.sleeve.md) | Namespace for sleeve functions. |
-|  [stanek](./bitburner.ns.stanek.md) | <code>readonly</code> | [Stanek](./bitburner.stanek.md) | Namespace for stanek functions. RAM cost: 0 GB |
+|  [singularity](./bitburner.ns.singularity.md) | <code>readonly</code> | [Singularity](./bitburner.singularity.md) | Namespace for singularity functions. Contains spoilers. |
+|  [sleeve](./bitburner.ns.sleeve.md) | <code>readonly</code> | [Sleeve](./bitburner.sleeve.md) | Namespace for sleeve functions. Contains spoilers. |
+|  [stanek](./bitburner.ns.stanek.md) | <code>readonly</code> | [Stanek](./bitburner.stanek.md) | Namespace for stanek functions. Contains spoilers. |
 |  [stock](./bitburner.ns.stock.md) | <code>readonly</code> | [TIX](./bitburner.tix.md) | Namespace for stock functions. |
-|  [ui](./bitburner.ns.ui.md) | <code>readonly</code> | [UserInterface](./bitburner.userinterface.md) | Namespace for user interface functions. RAM cost: 0 GB |
+|  [ui](./bitburner.ns.ui.md) | <code>readonly</code> | [UserInterface](./bitburner.userinterface.md) | Namespace for user interface functions. |
 
 ## Methods
 
diff --git a/markdown/bitburner.ns.singularity.md b/markdown/bitburner.ns.singularity.md
index 3dd1ca02d..97345d037 100644
--- a/markdown/bitburner.ns.singularity.md
+++ b/markdown/bitburner.ns.singularity.md
@@ -4,10 +4,15 @@
 
 ## NS.singularity property
 
-Namespace for singularity functions. RAM cost: 0 GB
+Namespace for singularity functions. Contains spoilers.
 
 **Signature:**
 
 ```typescript
 readonly singularity: Singularity;
 ```
+
+## Remarks
+
+RAM cost: 0 GB
+
diff --git a/markdown/bitburner.ns.sleeve.md b/markdown/bitburner.ns.sleeve.md
index 67fb98070..c40749758 100644
--- a/markdown/bitburner.ns.sleeve.md
+++ b/markdown/bitburner.ns.sleeve.md
@@ -4,7 +4,7 @@
 
 ## NS.sleeve property
 
-Namespace for sleeve functions.
+Namespace for sleeve functions. Contains spoilers.
 
 **Signature:**
 
diff --git a/markdown/bitburner.ns.stanek.md b/markdown/bitburner.ns.stanek.md
index 820fcf9dc..f7ac539e1 100644
--- a/markdown/bitburner.ns.stanek.md
+++ b/markdown/bitburner.ns.stanek.md
@@ -4,10 +4,15 @@
 
 ## NS.stanek property
 
-Namespace for stanek functions. RAM cost: 0 GB
+Namespace for stanek functions. Contains spoilers.
 
 **Signature:**
 
 ```typescript
 readonly stanek: Stanek;
 ```
+
+## Remarks
+
+RAM cost: 0 GB
+
diff --git a/markdown/bitburner.ns.ui.md b/markdown/bitburner.ns.ui.md
index 687f7242f..778ab289d 100644
--- a/markdown/bitburner.ns.ui.md
+++ b/markdown/bitburner.ns.ui.md
@@ -4,10 +4,15 @@
 
 ## NS.ui property
 
-Namespace for user interface functions. RAM cost: 0 GB
+Namespace for user interface functions.
 
 **Signature:**
 
 ```typescript
 readonly ui: UserInterface;
 ```
+
+## Remarks
+
+RAM cost: 0 GB
+
diff --git a/markdown/bitburner.singularity.checkfactioninvitations.md b/markdown/bitburner.singularity.checkfactioninvitations.md
index 3574f8c28..e0898b9ca 100644
--- a/markdown/bitburner.singularity.checkfactioninvitations.md
+++ b/markdown/bitburner.singularity.checkfactioninvitations.md
@@ -21,5 +21,5 @@ Array with the name of all Factions you currently have outstanding invitations f
 
 RAM cost: 3 GB \* 16/4/1
 
-Returns an array with the name of all Factions you currently have outstanding invitations from.
+Performs an immediate check for which factions you qualify for invites from, then returns an array with the name of all Factions you have outstanding invitations from.
 
diff --git a/src/ScriptEditor/NetscriptDefinitions.d.ts b/src/ScriptEditor/NetscriptDefinitions.d.ts
index 887d0d2f9..2e28c715e 100644
--- a/src/ScriptEditor/NetscriptDefinitions.d.ts
+++ b/src/ScriptEditor/NetscriptDefinitions.d.ts
@@ -1787,7 +1787,8 @@ export interface Singularity {
    * RAM cost: 3 GB * 16/4/1
    *
    *
-   * Returns an array with the name of all Factions you currently have outstanding invitations from.
+   * Performs an immediate check for which factions you qualify for invites from, then returns an array with the name
+   * of all Factions you have outstanding invitations from.
    *
    * @returns Array with the name of all Factions you currently have outstanding invitations from.
    */
@@ -4499,13 +4500,13 @@ interface UserInterface {
  */
 export interface NS {
   /**
-   * Namespace for hacknet functions.
-   * @remarks RAM cost: 4 GB
+   * Namespace for hacknet functions. Some of this API contains spoilers.
+   * @remarks RAM cost: 4 GB.
    */
   readonly hacknet: Hacknet;
 
   /**
-   * Namespace for bladeburner functions.
+   * Namespace for bladeburner functions. Contains spoilers.
    * @remarks RAM cost: 0 GB
    */
   readonly bladeburner: Bladeburner;
@@ -4517,13 +4518,13 @@ export interface NS {
   readonly codingcontract: CodingContract;
 
   /**
-   * Namespace for gang functions.
+   * Namespace for gang functions. Contains spoilers.
    * @remarks RAM cost: 0 GB
    */
   readonly gang: Gang;
 
   /**
-   * Namespace for sleeve functions.
+   * Namespace for sleeve functions. Contains spoilers.
    * @remarks RAM cost: 0 GB
    */
   readonly sleeve: Sleeve;
@@ -4541,37 +4542,37 @@ export interface NS {
   readonly formulas: Formulas;
 
   /**
-   * Namespace for stanek functions.
-   * RAM cost: 0 GB
+   * Namespace for stanek functions. Contains spoilers.
+   * @remarks RAM cost: 0 GB
    */
   readonly stanek: Stanek;
 
   /**
    * Namespace for infiltration functions.
-   * RAM cost: 0 GB
+   * @remarks RAM cost: 0 GB
    */
   readonly infiltration: Infiltration;
 
   /**
-   * Namespace for corporation functions.
-   * RAM cost: 1022.4 GB
+   * Namespace for corporation functions. Contains spoilers.
+   * @remarks RAM cost: 0 GB
    */
   readonly corporation: Corporation;
 
   /**
    * Namespace for user interface functions.
-   * RAM cost: 0 GB
+   * @remarks RAM cost: 0 GB
    */
   readonly ui: UserInterface;
 
   /**
-   * Namespace for singularity functions.
-   * RAM cost: 0 GB
+   * Namespace for singularity functions. Contains spoilers.
+   * @remarks RAM cost: 0 GB
    */
   readonly singularity: Singularity;
 
   /**
-   * Namespace for grafting functions.
+   * Namespace for grafting functions. Contains spoilers.
    * @remarks RAM cost: 0 GB
    */
   readonly grafting: Grafting;