Skip to content

Commit a994564

Browse files
Copilotmandrake-sw
andcommitted
docs: update TODO comments to clarify breaking change requirements
Co-authored-by: mandrake-sw <174416152+mandrake-sw@users.noreply.github.com>
1 parent d92384e commit a994564

File tree

1 file changed

+4
-2
lines changed

1 file changed

+4
-2
lines changed

src/lib/types.ts

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -45,8 +45,9 @@ export interface PropertyReference {
4545
}
4646

4747
/**
48-
* TODO: when the times comes, drop the default value for the `Tag`
49-
* paramter to enforce strong typing throughout the entire library.
48+
* TODO: when the time comes, drop the default value for the `Tag`
49+
* parameter to enforce strong typing throughout the entire library.
50+
* This would be a breaking change requiring major version bump.
5051
*/
5152
export interface TypedValue<
5253
Tag extends ApplicationTag = ApplicationTag,
@@ -125,6 +126,7 @@ export interface BACNetDevObjRef {
125126
/**
126127
* TODO: when the time comes, drop the default value for the `Tag` generic
127128
* parameter to enforce type safety everywhere throughout the library.
129+
* This would be a breaking change requiring major version bump.
128130
*/
129131
export interface BACNetAppData<
130132
Tag extends ApplicationTag = ApplicationTag,

0 commit comments

Comments
 (0)