mirror of
https://github.com/bitburner-official/bitburner-src.git
synced 2026-04-16 06:18:42 +02:00
work on doc
This commit is contained in:
31
markdown/bitburner.codingcontract.getdescription.md
Normal file
31
markdown/bitburner.codingcontract.getdescription.md
Normal file
@@ -0,0 +1,31 @@
|
||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [bitburner](./bitburner.md) > [CodingContract](./bitburner.codingcontract.md) > [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
|
||||
|
||||
Contract’s text description.
|
||||
|
||||
## Remarks
|
||||
|
||||
5 GB
|
||||
|
||||
Reference in New Issue
Block a user