Skip to content

Commit e3288e6

Browse files
committed
I messed up JSDoc again
1 parent 9d25fb1 commit e3288e6

3 files changed

Lines changed: 9 additions & 3 deletions

File tree

packages/types/CHANGELOG.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,12 @@ For prereleases:
1919
- Pre-release versions (x.x.x-pre.x) are unstable releases for the designated API version. These contain work-in-progress types and annotations. Pre-release versions are not meant to be used except for trying out new API interfaces and giving feedback, and may change without prior programmatic or verbal notice. Pre-release versions are meant to be used with new builds from the `dev` branch of the base extension repo.
2020
- Release candidates (x.x.x-rc.x) are stable previews for the designated API version. These contain types that are more or less finalized for the designated release. Breaking changes should not be expected, both in type signature and functionality, but will always be highlighted in the changelog if necessary. This is also meant for feedback, but only for more subtle feedback before releasing that version such that it simply just contains bug fixes and very minor changes.
2121

22+
## 1.0.0-pre.18
23+
24+
### Fixed
25+
26+
- Fixed broken JSDoc annotations on certain method signatures.
27+
2228
## 1.0.0-pre.17
2329

2430
### Breaking changes

packages/types/src/companions/register.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -44,14 +44,14 @@ export interface CompanionAPI extends Disposable {
4444
/**
4545
* Registers an action to Neuro.
4646
* You must have declared either the `actions:manage` or `actions:manage_others` contribution point.
47-
* @param actions An action name. That action must already have been added via {@link CompanionAPI.addActions}.
47+
* @param action An action name. That action must already have been added via {@link CompanionAPI.addActions}.
4848
*/
4949
registerAction(action: string): void;
5050

5151
/**
5252
* Unregisters an action to Neuro.
5353
* You must have declared either the `actions:manage` or `actions:manage_others` contribution point.
54-
* @param actions An action name. That action must already have been added via {@link CompanionAPI.addActions}
54+
* @param action An action name. That action must already have been added via {@link CompanionAPI.addActions}
5555
*/
5656
unregisterAction(action: string): void;
5757

packages/types/src/index.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -112,7 +112,7 @@ export interface NeuroPilotAPI {
112112
getAction<const TData extends object | undefined = any>(action: string): RCEAction<TData> & { source?: string; } | undefined;
113113
/**
114114
* Get an array of actions.
115-
* @param action An array of action names.
115+
* @param actions An array of action names.
116116
* @returns An array of {@link RCEAction} and their corresponding source companions.
117117
*/
118118
// eslint-disable-next-line @typescript-eslint/no-explicit-any

0 commit comments

Comments
 (0)