Skip to content

Commit

Permalink
Merge pull request #198 from stephentyrone/clarify-stability-differen…
Browse files Browse the repository at this point in the history
…tiable

Clarify that differentaible API is not stable.
  • Loading branch information
stephentyrone authored Aug 31, 2021
2 parents 1e5cbc4 + d560765 commit 0a23770
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ To use Swift Numerics in a SwiftPM project:
## Source stability

The Swift Numerics package is source stable; version numbers follow [Semantic Versioning](https://semver.org).
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.
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)*.
Interfaces that aren't part of the public API may continue to change in any release, including patch releases.

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

0 comments on commit 0a23770

Please sign in to comment.