Skip to content

Commit 1e5cbc4

Browse files
Merge pull request #195 from stephentyrone/readme-semver-1.0
Update README for 1.0.0.
2 parents 79f6025 + b4ec755 commit 1e5cbc4

File tree

1 file changed

+13
-3
lines changed

1 file changed

+13
-3
lines changed

README.md

+13-3
Original file line numberDiff line numberDiff line change
@@ -58,9 +58,19 @@ To use Swift Numerics in a SwiftPM project:
5858

5959
## Source stability
6060

61-
Swift Numerics uses semantic versioning.
62-
The public API of Swift Numerics is the non-underscored contents of the modules re-exported by the Numerics top-level module.
63-
E.g. the contents of `_NumericsShims` are not considered API, nor is the `_mulAdd` operation defined for `Real` types.
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.
6474

6575
## Contributing to Swift Numerics
6676

0 commit comments

Comments
 (0)