From 344054f10df556f26b32f22eb3e70de7caea1c62 Mon Sep 17 00:00:00 2001
From: catloversg <152669316+catloversg@users.noreply.github.com>
Date: Thu, 13 Jun 2024 09:07:05 +0700
Subject: [PATCH] DOCUMENTATION: Clarify maximum number of ports (#1388)

---
 markdown/bitburner.ns.writeport.md         | 2 ++
 src/ScriptEditor/NetscriptDefinitions.d.ts | 7 +++++++
 2 files changed, 9 insertions(+)

diff --git a/markdown/bitburner.ns.writeport.md b/markdown/bitburner.ns.writeport.md
index a6e4f95f2..48e1ebee8 100644
--- a/markdown/bitburner.ns.writeport.md
+++ b/markdown/bitburner.ns.writeport.md
@@ -31,3 +31,5 @@ RAM cost: 0 GB
 
 Write data to the given Netscript port.
 
+There is a limit on the maximum number of ports, but you won't reach that limit in normal situations. If you do, it usually means that there is a bug in your script that leaks port data. A port is freed when it does not have any data in its underlying queue. `ns.clearPort` deletes all data on a port. `ns.readPort` reads the first element in the port's queue, then removes it from the queue.
+
diff --git a/src/ScriptEditor/NetscriptDefinitions.d.ts b/src/ScriptEditor/NetscriptDefinitions.d.ts
index 1d47d472e..4a7d9bbe6 100644
--- a/src/ScriptEditor/NetscriptDefinitions.d.ts
+++ b/src/ScriptEditor/NetscriptDefinitions.d.ts
@@ -6891,11 +6891,18 @@ export interface NS {
    * RAM cost: 0 GB
    *
    * Write data to the given Netscript port.
+   *
+   * There is a limit on the maximum number of ports, but you won't reach that limit in normal situations. If you do, it
+   * usually means that there is a bug in your script that leaks port data. A port is freed when it does not have any
+   * data in its underlying queue. `ns.clearPort` deletes all data on a port. `ns.readPort` reads the first element in
+   * the port's queue, then removes it from the queue.
+   *
    * @param portNumber - Port to write to. Must be a positive integer.
    * @param data - Data to write, it's cloned with structuredClone().
    * @returns The data popped off the queue if it was full, or null if it was not full.
    */
   writePort(portNumber: number, data: any): any;
+
   /**
    * Read data from a port.
    * @remarks