Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add note regarding i8 to docs #458

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Add note regarding i8 to docs #458

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 8 additions & 4 deletions docs/docs/content/number.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,11 +1,12 @@
Synth's `number` type allows for generating fixed-width numbers.
Synth's `number` type allows for generating fixed-width numbers.

### Parameters
### Parameters

#### `subtype`

All the variants of `number` accept an optional `"subtype"` field to specify
the width and primitive kind of the values generated. The value of `"subtype"`,
if specified, must be one of `u64`, `i64`, `f64`, `u32`, `i32`, `f32`.
if specified, must be one of `u64`, `i64`, `f64`, `u32`, `i32`, `f32`, `i8`.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is the only actual real change here, the rest are formatting autolints.

#### Example

Expand All @@ -32,6 +33,7 @@ will have different default behavior based on the value of `"subtype"`.
- For float subtypes (`f32`, `f64`): `number` will default to generating from the semi-open interval `[0, 1)`.

#### Example

```json synth
{
"type": "number",
Expand All @@ -40,6 +42,7 @@ will have different default behavior based on the value of `"subtype"`.
```

#### Example

```json synth
{
"type": "number",
Expand Down Expand Up @@ -198,4 +201,5 @@ Synth currently supports `u64` ids.
}
}
}
```
```

Loading