bitburner-src/doc/source/netscript/codingcontractapi/getDescription.rst
MageKing17 ae15914efa Update netscript documentation.
Unfortunately, I haven't used most of the specialty APIs yet, so I'm not intimately familiar with where their documentation might be wrong. I figured some fixes were better than no fixes, and I can always make more fixes later.

Fixes #1023.
2021-07-06 00:18:22 -07:00

19 lines
610 B
ReStructuredText

getDescription() Netscript Function
===================================
.. 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");