Skip to content

Commit

Permalink
FIX: Minor documentation clarification
Browse files Browse the repository at this point in the history
  • Loading branch information
NagaOuroboros committed Mar 2, 2025
1 parent 5f22a8f commit 3575ea4
Show file tree
Hide file tree
Showing 5 changed files with 9 additions and 10 deletions.
2 changes: 1 addition & 1 deletion markdown/bitburner.ns.dnslookup.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

## NS.dnsLookup() method

Given a hostname, returns an IP address, Given an IP address, returns a hostname
Given a hostname, returns its IP address; or given an IP address, returns its hostname.

**Signature:**

Expand Down
6 changes: 3 additions & 3 deletions markdown/bitburner.ns.md
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ export async function main(ns) {
| [closeTail(pid)](./bitburner.ns.closetail.md) | Close the tail window of a script. This function is deprecated and will be removed in a later version. |
| [deleteServer(host)](./bitburner.ns.deleteserver.md) | Delete a purchased server. |
| [disableLog(fn)](./bitburner.ns.disablelog.md) | Disables logging for the given NS function. |
| [dnsLookup(host)](./bitburner.ns.dnslookup.md) | Given a hostname, returns an IP address, Given an IP address, returns a hostname |
| [dnsLookup(host)](./bitburner.ns.dnslookup.md) | Given a hostname, returns its IP address; or given an IP address, returns its hostname. |
| [enableLog(fn)](./bitburner.ns.enablelog.md) | Enables logging for the given NS function. |
| [exec(script, host, threadOrOptions, args)](./bitburner.ns.exec.md) | Start another script on any server. |
| [exit()](./bitburner.ns.exit.md) | Terminates the current script immediately. |
Expand Down Expand Up @@ -154,8 +154,8 @@ export async function main(ns) {
| [resizeTail(width, height, pid)](./bitburner.ns.resizetail.md) | Resize a tail window. This function is deprecated and will be removed in a later version. |
| [rm(name, host)](./bitburner.ns.rm.md) | Delete a file. |
| [run(script, threadOrOptions, args)](./bitburner.ns.run.md) | Start another script on the current server. |
| [scan(host)](./bitburner.ns.scan.md) | Get the list of servers connected to a server. |
| [scanByIP(host)](./bitburner.ns.scanbyip.md) | Get the list of servers connected to a server. |
| [scan(host)](./bitburner.ns.scan.md) | Get the list of hostnames connected to a server. |
| [scanByIP(host)](./bitburner.ns.scanbyip.md) | Get the list of IPs connected to a server. |
| [scp(files, destination, source)](./bitburner.ns.scp.md) | Copy file between servers. |
| [scriptKill(script, host)](./bitburner.ns.scriptkill.md) | Kill all scripts with a filename. |
| [scriptRunning(script, host)](./bitburner.ns.scriptrunning.md) | Check if any script with a filename is running. |
Expand Down
2 changes: 1 addition & 1 deletion markdown/bitburner.ns.scan.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

## NS.scan() method

Get the list of servers connected to a server.
Get the list of hostnames connected to a server.

**Signature:**

Expand Down
2 changes: 1 addition & 1 deletion markdown/bitburner.ns.scanbyip.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

## NS.scanByIP() method

Get the list of servers connected to a server.
Get the list of IPs connected to a server.

**Signature:**

Expand Down
7 changes: 3 additions & 4 deletions src/ScriptEditor/NetscriptDefinitions.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -6718,7 +6718,7 @@ export interface NS {
setTitle(title: string | ReactNode, pid?: number): void;

/**
* Get the list of servers connected to a server.
* Get the list of hostnames connected to a server.
* @remarks
* RAM cost: 0.2 GB
*
Expand Down Expand Up @@ -6776,7 +6776,7 @@ export interface NS {
scan(host?: string): string[];

/**
* Get the list of servers connected to a server.
* Get the list of IPs connected to a server.
* @remarks
* RAM cost: 0.2 GB
*
Expand Down Expand Up @@ -7366,8 +7366,7 @@ export interface NS {
getServerNumPortsRequired(host: string): number;

/**
* Given a hostname, returns an IP address,
* Given an IP address, returns a hostname
* Given a hostname, returns its IP address; or given an IP address, returns its hostname.
*
* @remarks RAM cost: 0 GB
* @param host - Hostname/IP of target server.
Expand Down

0 comments on commit 3575ea4

Please sign in to comment.