You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: develop-docs/sdk/processes/breaking_changes.mdx
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -32,7 +32,7 @@ In general, it's good to explicitly point out which parts of the API are public
32
32
In some SDKs, the line between public and private API is unclear, in which case you need to be more mindful of users possibly using functions that weren't meant to be public. In these cases, you need to make a decision. If unsure, discuss with your teammates. Some pointers:
33
33
- Is the API mentioned in the user-facing docs? Then it's highly likely public, and you should consider making changes to it in a major release.
34
34
- Was the code you're changing solely created for an internal purpose? Is it a utility or a helper function? Then it's fine to change.
35
-
- Have you seen this function be used in user code, for example in issue reproduction examples in your repo?
35
+
- Have you seen the function used in user code, for example in issue reproduction examples in your repo?
36
36
37
37
Naturally, the language of your SDK and the community around it also affects what is generally considered a breaking change. Some languages provide their own guidelines:
0 commit comments