Personal_mirrors/bitburner-src
1
0
Fork 0
mirror of https://github.com/bitburner-official/bitburner-src.git synced 2024-12-19 04:35:46 +01:00
Code Issues Packages Projects Releases Wiki Activity

DOC: ns.exec(): break example comments into multiple lines

Browse Source 
The comment of each example is so long that, in the generated documentation for `ns.exec()` shown at

https://github.com/danielyxie/bitburner/blob/dev/markdown/bitburner.ns.exec.md

you must use the horizontal scrollbar to read the whole comment.  Even if you maximize the browser window, you must still use the horizontal scrollbar to read the whole comment.  Tested on Brave, Chrome, Firefox, and Opera.  Fix this by limiting each line of comment to at most 90 characters.
This commit is contained in:
Duck McSouls 2022-10-06 22:48:15 +11:00
parent 5edcdaad81
commit e3ace9f6d5
1 changed files with 16 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
src/ScriptEditor/NetscriptDefinitions.d.ts vendored
View File

@ -5383,25 +5383,35 @@ export interface NS {
* @example
* ```ts
* // NS1:
* //The simplest way to use the exec command is to call it with just the script name and the target server. The following example will try to run generic-hack.script on the foodnstuff server:
* // The simplest way to use the exec command is to call it with just the script name
* // and the target server. The following example will try to run generic-hack.script
* // on the foodnstuff server.
* exec("generic-hack.script", "foodnstuff");
*
* //The following example will try to run the script generic-hack.script on the joesguns server with 10 threads:
* // The following example will try to run the script generic-hack.script on the
* // joesguns server with 10 threads.
* exec("generic-hack.script", "joesguns", 10);
*
* //This last example will try to run the script foo.script on the foodnstuff server with 5 threads. It will also pass the number 1 and the string “test” in as arguments to the script:
* // This last example will try to run the script foo.script on the foodnstuff server
* // with 5 threads. It will also pass the number 1 and the string “test” in as
* // arguments to the script.
* exec("foo.script", "foodnstuff", 5, 1, "test");
* ```
* @example
* ```ts
* // NS2:
* //The simplest way to use the exec command is to call it with just the script name and the target server. The following example will try to run generic-hack.script on the foodnstuff server:
* // The simplest way to use the exec command is to call it with just the script name
* // and the target server. The following example will try to run generic-hack.script
* // on the foodnstuff server.
* ns.exec("generic-hack.script", "foodnstuff");
*
* //The following example will try to run the script generic-hack.script on the joesguns server with 10 threads:
* // The following example will try to run the script generic-hack.script on the
* // joesguns server with 10 threads.
* ns.exec("generic-hack.script", "joesguns", 10);
*
* //This last example will try to run the script foo.script on the foodnstuff server with 5 threads. It will also pass the number 1 and the string “test” in as arguments to the script:
* // This last example will try to run the script foo.script on the foodnstuff server
* // with 5 threads. It will also pass the number 1 and the string “test” in as
* // arguments to the script.
* ns.exec("foo.script", "foodnstuff", 5, 1, "test");
* ```
* @param script - Filename of script to execute.