Skip to content

Commit b505d3c

Browse files
committed
Merge pull request #198 from stephentyrone/clarify-stability-differentiable
Clarify that differentaible API is not stable.
1 parent 7738390 commit b505d3c

File tree

1 file changed

+1
-1
lines changed

1 file changed

+1
-1
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@ To use Swift Numerics in a SwiftPM project:
5959
## Source stability
6060

6161
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.
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, *excepting any API that involves a conformance to Differentiable (because Differentiable itself is not stable in Swift)*.
6363
Interfaces that aren't part of the public API may continue to change in any release, including patch releases.
6464

6565
Note that contents of the `_NumericsShims` and `_TestSupport` modules, as well as contents of the `Tests` directory, explicitly are not public API.

0 commit comments

Comments
 (0)