Skip to content

Commit

Permalink
docs: clarify runtime vs static compilation
Browse files Browse the repository at this point in the history
  • Loading branch information
samuelmaddock committed Oct 3, 2024
1 parent ebffa71 commit 25847cf
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion wg-api/best-practices.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ API changes which alter existing behavior can cause apps to break unexpectedly w
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.

> [!NOTE]
> Changes that only affect TypeScript type definitions are not considered breaking changes.
> 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.
### How will this API be extended in the future?

Expand Down

0 comments on commit 25847cf

Please sign in to comment.