felixfoertsch/bitburner-src
1
0
Fork 0
mirror of https://github.com/bitburner-official/bitburner-src.git synced 2026-04-16 14:28:36 +02:00
Code Issues Packages Projects Releases Wiki Activity

work to make documentation unified.

Browse Source
This commit is contained in:
Olivier Gagnon
2021-03-12 02:51:56 -05:00
parent a00c253dcb
commit 2ce6ff2041
176 changed files with 1325 additions and 916 deletions
Download Patch File Download Diff File Expand all files Collapse all files

22
doc/source/netscript/codingcontractapi/getDescription.rst
View File

@@ -1,14 +1,18 @@
getDescription() Netscript Function
===================================
.. js:function:: getDescription(fn[, hostname/ip=current ip])
:param string fn: Filename of the contract
:param string hostname/ip: Hostname or IP of the server containing the contract.
Optional. Defaults to current server if not provided
Get the full text description for the problem posed by the Coding Contract
:returns: A string with the contract's text description
.. js:function:: getDescription(filename[, hostname=current hostname])
:RAM cost: 5 GB
:param string filename: Filename of the contract
:param string hostname: Hostname of the server containing the contract.
Optional. Defaults to current server if not provided
:returns: A string with the contract's text description
Get the full text description for the problem posed by the Coding Contract.
Example:
.. code-block:: javascript
codingcontract.getDescription("contract-123.cct", "home");