Skip to content

Commit 25847cf

Browse files
committed
docs: clarify runtime vs static compilation
1 parent ebffa71 commit 25847cf

File tree

1 file changed

+1
-1
lines changed

1 file changed

+1
-1
lines changed

wg-api/best-practices.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ API changes which alter existing behavior can cause apps to break unexpectedly w
1313
If the behavior must change to support the feature, the change should be listed in [the breaking changes document](https://github.com/electron/electron/blob/main/docs/breaking-changes.md). Additionally, consider whether the change can be introduced in a way which permits a deprecation cycle, for instance introducing the new API under a new name and deprecating the old name while keeping the behavior unchanged for apps using the API under the old name.
1414

1515
> [!NOTE]
16-
> Changes that only affect TypeScript type definitions are not considered breaking changes.
16+
> Breaking changes should be that which affects JavaScript runtime usage. If a change affects type definitions which breaks static compilation of a TypeScript app, that is not enough to be considered a breaking change.
1717
1818
### How will this API be extended in the future?
1919

0 commit comments

Comments
 (0)