mirror of
https://github.com/bitburner-official/bitburner-src.git
synced 2026-04-17 23:08:36 +02:00
CODEBASE: Update api-documentor and api-extractor (#2320)
* Update api-documentor and api-extractor. #1566 follow-up.
I have verified that the HTML/markdown table generation bug in
[#4878](https://github.com/microsoft/rushstack/issues/4878) in rushstack
for api-documentor has been fixed as per rushstack#5256. The testcase
[repro](https://github.com/catloversg/api-documenter-bug-pr-4578) now
produces the correct expected output.
I have confirmed that the generated output in bitburner from
`npm run doc` now generated HTML tables, and correctly inserts
a blank line between the </table> and the follow line (e.g. Returns).
Stylisticly it could use some whitespace, but it is correctly rendered.
This commit is only the updated packages, not the updated generated
documentation. I assume that is automatically generated by the GitHub
workflow.
* Follow up to 5f732a6f35, include `npm run doc` changed docs.
* Add missing license info
* Fix React warning
---------
Co-authored-by: CatLover <152669316+catloversg@users.noreply.github.com>
This commit is contained in:
@@ -14,11 +14,71 @@ gymWorkout(gymName: GymLocationName, stat: GymType, focus?: boolean): boolean;
|
||||
|
||||
## Parameters
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| gymName | [GymLocationName](./bitburner.gymlocationname.md) | Name of gym. You must be in the correct city for whatever gym you specify. |
|
||||
| stat | [GymType](./bitburner.gymtype.md) | The stat you want to train. |
|
||||
| focus | boolean | _(Optional)_ Acquire player focus on this gym workout. Optional. Defaults to true. |
|
||||
<table><thead><tr><th>
|
||||
|
||||
Parameter
|
||||
|
||||
|
||||
</th><th>
|
||||
|
||||
Type
|
||||
|
||||
|
||||
</th><th>
|
||||
|
||||
Description
|
||||
|
||||
|
||||
</th></tr></thead>
|
||||
<tbody><tr><td>
|
||||
|
||||
gymName
|
||||
|
||||
|
||||
</td><td>
|
||||
|
||||
[GymLocationName](./bitburner.gymlocationname.md)
|
||||
|
||||
|
||||
</td><td>
|
||||
|
||||
Name of gym. You must be in the correct city for whatever gym you specify.
|
||||
|
||||
|
||||
</td></tr>
|
||||
<tr><td>
|
||||
|
||||
stat
|
||||
|
||||
|
||||
</td><td>
|
||||
|
||||
[GymType](./bitburner.gymtype.md)
|
||||
|
||||
|
||||
</td><td>
|
||||
|
||||
The stat you want to train.
|
||||
|
||||
|
||||
</td></tr>
|
||||
<tr><td>
|
||||
|
||||
focus
|
||||
|
||||
|
||||
</td><td>
|
||||
|
||||
boolean
|
||||
|
||||
|
||||
</td><td>
|
||||
|
||||
_(Optional)_ Acquire player focus on this gym workout. Optional. Defaults to true.
|
||||
|
||||
|
||||
</td></tr>
|
||||
</tbody></table>
|
||||
|
||||
**Returns:**
|
||||
|
||||
|
||||
Reference in New Issue
Block a user