work on doc

This commit is contained in:
Olivier Gagnon
2021-10-30 12:34:14 -04:00
parent f99c3fd0cd
commit 43fc5dfd48
589 changed files with 63720 additions and 1168 deletions

View File

@@ -0,0 +1,31 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [CodingContract](./bitburner.codingcontract.md) &gt; [getDescription](./bitburner.codingcontract.getdescription.md)
## CodingContract.getDescription() method
Get the full text description for the problem posed by the Coding Contract.
<b>Signature:</b>
```typescript
getDescription(fn: string, host?: Host): string;
```
## Parameters
| Parameter | Type | Description |
| --- | --- | --- |
| fn | string | Filename of the contract. |
| host | [Host](./bitburner.host.md) | Host or IP of the server containing the contract. Optional. Defaults to current server if not provided. |
<b>Returns:</b>
string
Contracts text description.
## Remarks
5 GB