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: README.md
+16Lines changed: 16 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -56,6 +56,22 @@ To use Swift Numerics in a SwiftPM project:
56
56
57
57
3. Add `import Numerics` in your source code.
58
58
59
+
## Source stability
60
+
61
+
The Swift Numerics package is source stable; version numbers follow [Semantic Versioning](https://semver.org).
62
+
The public API of the `swift-numerics` package consists of non-underscored declarations that are marked either `public` or `usableFromInline` in modules re-exported by the top-level `Numerics` module.
63
+
Interfaces that aren't part of the public API may continue to change in any release, including patch releases.
64
+
65
+
Note that contents of the `_NumericsShims` and `_TestSupport` modules, as well as contents of the `Tests` directory, explicitly are not public API.
66
+
The definitions therein may therefore change at whim, and the entire module may be removed in any new release.
67
+
If you have a use case that requires underscored operations, please raise an issue to request that they be made public API.
68
+
69
+
Future minor versions of the package may introduce changes to these rules as needed.
70
+
71
+
We'd like this package to quickly embrace Swift language and toolchain improvements that are relevant to its mandate.
72
+
Accordingly, from time to time, we expect that new versions of this package will require clients to upgrade to a more recent Swift toolchain release.
73
+
Requiring a new Swift release will only require a minor version bump.
74
+
59
75
## Contributing to Swift Numerics
60
76
61
77
Swift Numerics is a standalone library that is separate from the core Swift project, but it will sometimes act as a staging ground for APIs that will later be incorporated into the Swift Standard Library.
0 commit comments