From 93435d519a3a8c8b0777f3ad3e325f2821814bdb Mon Sep 17 00:00:00 2001
From: Graham Esau <gesau@hotmail.co.uk>
Date: Thu, 25 Mar 2021 22:51:51 +0000
Subject: [PATCH] Update docs

---
 README.md                     |  2 +-
 docs/3-generating.md          |  2 +-
 docs/examples/8-enum_repr.md  |  5 +++--
 docs/examples/9-from_value.md | 17 +++++++++++++++++
 schemars/src/lib.rs           |  2 +-
 5 files changed, 23 insertions(+), 5 deletions(-)
 create mode 100644 docs/examples/9-from_value.md

diff --git a/README.md b/README.md
index d2b97ff..be80bb4 100644
--- a/README.md
+++ b/README.md
@@ -200,7 +200,7 @@ println!("{}", serde_json::to_string_pretty(&schema).unwrap());
 
 `#[serde(...)]` attributes can be overriden using `#[schemars(...)]` attributes, which behave identically (e.g. `#[schemars(rename_all = "camelCase")]`). You may find this useful if you want to change the generated schema without affecting Serde's behaviour, or if you're just not using Serde.
 
-### Schema from Example Values
+### Schema from Example Value
 
 If you want a schema for a type that can't/doesn't implement `JsonSchema`, but does implement `serde::Serialize`, then you can generate a JSON schema from a value of that type. However, this schema will generally be less precise than if the type implemented `JsonSchema` - particularly when it involves enums, since schemars will not make any assumptions about the structure of an enum based on a single variant.
 
diff --git a/docs/3-generating.md b/docs/3-generating.md
index cc65004..e9cf09e 100644
--- a/docs/3-generating.md
+++ b/docs/3-generating.md
@@ -21,7 +21,7 @@ If you want more control over how the schema is generated, you can use the [`gen
 See the API documentation for more info on how to use those types for custom schema generation.
 
 <!-- UNCOMMMENT FOR 0.8.2:
-## Schema from Example Values
+## Schema from Example Value
 
 If you want a schema for a type that can't/doesn't implement `JsonSchema`, but does implement `serde::Serialize`, then you can generate a JSON schema from a value of that type using the [`schema_for_value!` macro](https://docs.rs/schemars/latest/schemars/macro.schema_for_value.html). However, this schema will generally be less precise than if the type implemented `JsonSchema` - particularly when it involves enums, since schemars will not make any assumptions about the structure of an enum based on a single variant.
 
diff --git a/docs/examples/8-enum_repr.md b/docs/examples/8-enum_repr.md
index 8b43ce0..7704956 100644
--- a/docs/examples/8-enum_repr.md
+++ b/docs/examples/8-enum_repr.md
@@ -1,13 +1,14 @@
 ---
 layout: default
-title: Serialize enum as number (serde_repr)
+title: Serialize Enum as Number (serde_repr)
 parent: Examples
 nav_order: 8
 summary: >-
   Generating a schema for with a C-like enum compatible with serde_repr.
+nav_exclude: true # schemars 0.8.2 currently unreleased
 ---
 
-# Deriving JsonSchema with Fields Using Custom Serialization
+# Serialize Enum as Number (serde_repr Compatibility)
 
 If you use the `#[repr(...)]` attribute on an enum to give it a C-like representation, then you may also want to use the [serde_repr](https://github.com/dtolnay/serde-repr) crate to serialize the enum values as numbers. In this case, you should use the corresponding `JsonSchema_repr` derive to ensure the schema for your type reflects how serde formats your type.
 
diff --git a/docs/examples/9-from_value.md b/docs/examples/9-from_value.md
new file mode 100644
index 0000000..ec1b50b
--- /dev/null
+++ b/docs/examples/9-from_value.md
@@ -0,0 +1,17 @@
+---
+layout: default
+title: Generate Schema from Example Value
+parent: Examples
+nav_order: 9
+summary: >-
+  Generating a schema for a serializable value.
+nav_exclude: true # schemars 0.8.2 currently unreleased
+---
+
+# Generate Schema from Example Value
+
+If you want a schema for a type that can't/doesn't implement `JsonSchema`, but does implement [`serde::Serialize`](https://docs.serde.rs/serde/trait.Serialize.html), then you can generate a JSON schema from a value of that type. However, this schema will generally be less precise than if the type implemented `JsonSchema` - particularly when it involves enums, since schemars will not make any assumptions about the structure of an enum based on a single variant.
+
+{% include example.md name="from_value" %}
+
+Note that the schema for the enum is not very useful in this case, since schemars doesn't know anything about the second variant.
diff --git a/schemars/src/lib.rs b/schemars/src/lib.rs
index 388e6a9..16d8d8c 100644
--- a/schemars/src/lib.rs
+++ b/schemars/src/lib.rs
@@ -195,7 +195,7 @@ println!("{}", serde_json::to_string_pretty(&schema).unwrap());
 
 `#[serde(...)]` attributes can be overriden using `#[schemars(...)]` attributes, which behave identically (e.g. `#[schemars(rename_all = "camelCase")]`). You may find this useful if you want to change the generated schema without affecting Serde's behaviour, or if you're just not using Serde.
 
-### Schema from Example Values
+### Schema from Example Value
 
 If you want a schema for a type that can't/doesn't implement `JsonSchema`, but does implement `serde::Serialize`, then you can generate a JSON schema from a value of that type. However, this schema will generally be less precise than if the type implemented `JsonSchema` - particularly when it involves enums, since schemars will not make any assumptions about the structure of an enum based on a single variant.