Fix documentation for the import_types macro (#758)

oxidecomputer · Jan 30, 2025 · 5721eca · 5721eca
1 parent 7760d9b
commit 5721eca
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 5 deletions.
diff --git a/README.md b/README.md
@@ -144,8 +144,8 @@ For the macro:
 ```rust
 typify::import_types!(
   schema = "schema.json",
-  unknown_types = Allow,
-  crates {
+  unknown_crates = Allow,
+  crates = {
     "oxnet" = "1.0.0"
   }
 )

diff --git a/typify-macro/src/lib.rs b/typify-macro/src/lib.rs
@@ -40,10 +40,10 @@ mod token_utils;
 ///
 /// - `unknown_crates`: optional policy regarding the handling of schemas that
 ///   contain the `x-rust-type` extension whose crates are not explicitly named
-///   in the `crates` section. The options are `generate` to ignore the
-///   extension and generate a *de novo* type, `allow` to use the named type
+///   in the `crates` section. The options are `Generate` to ignore the
+///   extension and generate a *de novo* type, `Allow` to use the named type
 ///   (which may require the addition of a new dependency to compile, and which
-///   ignores version compatibility checks), or `deny` to produce a
+///   ignores version compatibility checks), or `Deny` to produce a
 ///   compile-time error (requiring the user to specify the crate's disposition
 ///   in the `crates` section).
 ///