Skip to content

Commit

Permalink
chore(docs): use tilde requirements to minimize breakage on users' end
Browse files Browse the repository at this point in the history
  • Loading branch information
IceTDrinker committed Feb 25, 2025
1 parent ab36f36 commit ec3f3a1
Show file tree
Hide file tree
Showing 10 changed files with 14 additions and 14 deletions.
2 changes: 1 addition & 1 deletion tfhe/docs/configuration/run_on_gpu.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ This guide explains how to update your existing program to leverage GPU accelera
To use the **TFHE-rs** GPU backend in your project, add the following dependency in your `Cargo.toml`.

```toml
tfhe = { version = "1.0.0", features = ["boolean", "shortint", "integer", "gpu"] }
tfhe = { version = "~1.0.0", features = ["boolean", "shortint", "integer", "gpu"] }
```

{% hint style="success" %}
Expand Down
4 changes: 2 additions & 2 deletions tfhe/docs/fhe-computation/data-handling/data_versioning.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,8 +16,8 @@ You can load serialized data with the `unversionize` function, even in newer ver

[dependencies]
# ...
tfhe = { version = "1.0.0", features = ["integer"] }
tfhe-versionable = "0.4.0"
tfhe = { version = "~1.0.0", features = ["integer"] }
tfhe-versionable = "0.5.0"
bincode = "1.3.3"
```

Expand Down
2 changes: 1 addition & 1 deletion tfhe/docs/fhe-computation/data-handling/serialization.md
Original file line number Diff line number Diff line change
Expand Up @@ -161,7 +161,7 @@ In the following example, we use [bincode](https://crates.io/crates/bincode) for

[dependencies]
# ...
tfhe = { version = "1.0.0", features = ["integer"] }
tfhe = { version = "~1.0.0", features = ["integer"] }
bincode = "1.3.3"
```

Expand Down
2 changes: 1 addition & 1 deletion tfhe/docs/fhe-computation/types/array.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ The following example shows a complete workflow of working with encrypted arrays
# Cargo.toml

[dependencies]
tfhe = { version = "1.0.0", features = ["integer"] }
tfhe = { version = "~1.0.0", features = ["integer"] }
```

```rust
Expand Down
2 changes: 1 addition & 1 deletion tfhe/docs/fhe-computation/types/strings.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ Here is an example:
# Cargo.toml

[dependencies]
tfhe = { version = "1.0.0", features = ["integer", "strings"] }
tfhe = { version = "~1.0.0", features = ["integer", "strings"] }
```

```rust
Expand Down
4 changes: 2 additions & 2 deletions tfhe/docs/getting_started/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ This document provides instructions to set up **TFHE-rs** in your project.
First, add **TFHE-rs** as a dependency in your `Cargo.toml`.

```toml
tfhe = { version = "1.0.0", features = ["boolean", "shortint", "integer"] }
tfhe = { version = "~1.0.0", features = ["boolean", "shortint", "integer"] }
```

{% hint style="info" %}
Expand Down Expand Up @@ -35,5 +35,5 @@ By default, **TFHE-rs** makes the assumption that hardware AES features are enab
To add support for older CPU, import **TFHE-rs** with the `software-prng` feature in your `Cargo.toml`:

```toml
tfhe = { version = "1.0.0", features = ["boolean", "shortint", "integer", "software-prng"] }
tfhe = { version = "~1.0.0", features = ["boolean", "shortint", "integer", "software-prng"] }
```
4 changes: 2 additions & 2 deletions tfhe/docs/getting_started/quick_start.md
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ edition = "2021"
Then add the following configuration to include **TFHE-rs**:

```toml
tfhe = { version = "1.0.0", features = ["integer"] }
tfhe = { version = "~1.0.0", features = ["integer"] }
```

Your updated `Cargo.toml` file should look like this:
Expand All @@ -71,7 +71,7 @@ version = "0.1.0"
edition = "2021"

[dependencies]
tfhe = { version = "1.0.0", features = ["integer"] }
tfhe = { version = "~1.0.0", features = ["integer"] }
```

If you are on a different platform please refer to the [installation documentation](installation.md) for configuration options of other supported platforms.
Expand Down
2 changes: 1 addition & 1 deletion tfhe/docs/references/core-crypto-api/tutorial.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ Welcome to this tutorial about `TFHE-rs` `core_crypto` module.
To use `TFHE-rs`, it first has to be added as a dependency in the `Cargo.toml`:

```toml
tfhe = { version = "1.0.0" }
tfhe = { version = "~1.0.0" }
```

### Commented code to double a 2-bit message in a leveled fashion and using a PBS with the `core_crypto` module.
Expand Down
4 changes: 2 additions & 2 deletions tfhe/docs/tutorials/ascii_fhe_string.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ To use the `FheUint8` type, enable the `integer` feature:
# Cargo.toml

[dependencies]
tfhe = { version = "1.0.0", features = ["integer"] }
tfhe = { version = "~1.0.0", features = ["integer"] }
```

The `MyFheString::encrypt` function performs data validation to ensure the input string contains only ASCII characters.
Expand Down Expand Up @@ -167,7 +167,7 @@ First, add the feature in your `Cargo.toml`
# Cargo.toml

[dependencies]
tfhe = { version = "1.0.0", features = ["strings"] }
tfhe = { version = "~1.0.0", features = ["strings"] }
```

The `FheAsciiString` type allows to simply do homomorphic case changing of encrypted strings (and much more!):
Expand Down
2 changes: 1 addition & 1 deletion tfhe/docs/tutorials/parity_bit.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ This function returns a Boolean (`true` or `false`) so that the total count of `
```toml
# Cargo.toml

tfhe = { version = "1.0.0", features = ["integer"] }
tfhe = { version = "~1.0.0", features = ["integer"] }
```

First, define the verification function.
Expand Down

0 comments on commit ec3f3a1

Please sign in to comment.