Skip to content

Commit ebf8869

Browse files
authored
Minor doc cleanups (#185)
1 parent 9530816 commit ebf8869

File tree

2 files changed

+4
-2
lines changed

2 files changed

+4
-2
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -93,7 +93,7 @@ To use the `HomomorphicEncryption` library, add
9393
to your target's dependencies.
9494

9595
> [!IMPORTANT]
96-
> When linking your executable, make sure to enable `cross-module-optimization`.
96+
> When linking your executable, make sure to set `-cross-module-optimization`.
9797
> Without this flag, performance of Swift Homomorphic Encryption degrades dramatically,
9898
> due to failure to specialize generics. For example,
9999
> ```swift

Sources/HomomorphicEncryption/HomomorphicEncryption.docc/UsingSwiftHomomorphicEncryption.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ To use the `HomomorphicEncryption` library, add
2020
to your target's dependencies.
2121

2222
> Important:
23-
> When linking your executable, make sure to enable `cross-module-optimization`.
23+
> When linking your executable, make sure to set `-cross-module-optimization`.
2424
> Without this flag, performance of Swift Homomorphic Encryption degrades dramatically,
2525
> due to failure to specialize generics. For example,
2626
> ```swift
@@ -64,3 +64,5 @@ Swift Homomorphic Encryption follows [Semantic Versioning 2.0.0](https://semver.
6464
Future minor versions of the package may introduce changes to these rules as needed.
6565

6666
We'd like this package to quickly embrace Swift language and toolchain improvements that are relevant to its mandate. 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. Requiring a new Swift release will only require a minor version bump.
67+
68+
> Warning: Any symbol beginning with an underscore, and any product beginning with an underscore, is not subject to semantic versioning: these APIs may change without warning.

0 commit comments

Comments
 (0)