address review comments

Created using spr 1.3.6-beta.1

Author: sunshowers

crates/newtype-uuid-macros/src/internals/imp.rs

@@ -409,7 +409,6 @@ fn generate_schemars_impl(
                 use ::#newtype_uuid_crate::macro_support::schemars08::schema::*;
 
                 let mut schema = SchemaObject {
-                    instance_type: ::std::option::Option::None,
                     subschemas: ::std::option::Option::Some(Box::new(SubschemaValidation {
                         not: ::std::option::Option::Some(Box::new(Schema::Bool(true))),
                         ..::std::default::Default::default()

crates/newtype-uuid-macros/src/lib.rs

@@ -56,7 +56,7 @@ use quote::ToTokens;
 ///
 /// By default, for a kind `Foo`, this macro generates:
 ///
-/// * A `FooKind` type that implements `TypedUuidKind`: `pub type FooKind {}`.
+/// * A `FooKind` type that implements `TypedUuidKind`: `pub enum FooKind {}`.
 /// * A `FooUuid` type alias: `pub type FooUuid = TypedUuid<FooKind>;`.
 ///
 /// ## Examples
@@ -68,26 +68,27 @@ use quote::ToTokens;
 /// impl_typed_uuid_kinds! {
 ///     kinds = {
 ///         User = {},
-///         Organization = {},
+///         BusinessUnit = {},
 ///     },
 /// }
 ///
-/// // This generates empty UserKind and OrganizationKind enums implementing
-/// // TypedUuidKind, with the tags "user" and "organization" respectively.
+/// // This generates empty UserKind and BusinessUnitKind enums implementing
+/// // TypedUuidKind, with the tags "user" and "business_unit" respectively.
 /// // Tags are snake_case versions of type names.
 /// assert_eq!(UserKind::tag().as_str(), "user");
-/// assert_eq!(OrganizationKind::tag().as_str(), "organization");
+/// assert_eq!(BusinessUnitKind::tag().as_str(), "business_unit");
 ///
-/// // The macro also generates UserUuid and OrganizationUuid type aliases.
+/// // The macro also generates UserUuid and BusinessUnitUuid type aliases.
 /// let user_uuid = UserUuid::new_v4();
-/// let organization_uuid = OrganizationUuid::new_v4();
+/// let business_unit_uuid = BusinessUnitUuid::new_v4();
 /// ```
 ///
 /// * The generated `Kind` types always implement `Clone`, `Copy`, `Debug`,
 ///   `Eq`, and `PartialEq`.
-/// * The `Kind` types are all empty (uninhabited) enums, which means that
-///   values for these types cannot be created. (Using empty enums is the
-///   recommended approach for `newtype-uuid`).
+/// * The `Kind` types are all empty enums, also known as *marker* or
+///   *uninhabited* enums. This means that values for these types cannot be
+///   created. (Using empty enums is the recommended approach for
+///   `newtype-uuid`).
 ///
 /// # Per-kind settings
 ///
@@ -154,14 +155,15 @@ use quote::ToTokens;
 /// If the `schemars08` global setting is defined, the macro generates JSON
 /// Schema support for the `Kind` instances using [schemars 0.8].
 ///
-/// **To enable JSON Schema support, you'll need to turn on `newtype-uuid`'s
+/// **To enable JSON Schema support, you'll need to enable `newtype-uuid`'s
 /// `schemars08` feature.**
 ///
 /// Within `settings.schemars08`, the options are:
 ///
 /// - `attrs`: A list of attributes to apply to all generated `JsonSchema`
-///   implementations. This will often be something like `[#cfg(feature =
-///   "schemars-feature-name")]]`.
+///   implementations. For example, if `schemars` is an optional dependency
+///   for the crate where the macro is being invoked, you might specify something
+///   like `[#cfg(feature = "schemars")]`.
 /// - `rust_type`: If defined, adds the `x-rust-type` extension to the schema,
 ///   enabling automatic replacement with [`typify`] and other tools that
 ///   support it. *Optional, defaults to not adding the extension.*
@@ -201,7 +203,7 @@ use quote::ToTokens;
 ///             attrs = [#[cfg(feature = "schemars")]],
 ///             rust_type = {
 ///                 crate = "my-crate",
-///                 version = "*",
+///                 version = "0.1.0",
 ///                 path = "my_crate::types",
 ///             },
 ///         },

crates/newtype-uuid/src/lib.rs

@@ -41,7 +41,7 @@
 //! ```
 //!
 //! If you have a large number of UUID kinds, consider using
-//! [`newtype-uuid-macros`] which comes with several convenience features:
+//! [`newtype-uuid-macros`] which comes with several convenience features.
 //!
 //! ```
 //! use newtype_uuid_macros::impl_typed_uuid_kinds;
@@ -151,6 +151,7 @@ extern crate alloc;
 /// This module re-exports types needed for [`newtype-uuid-macros`] to work.
 ///
 /// [`newtype-uuid-macros`]: https://docs.rs/newtype-uuid-macros
+#[doc(hidden)]
 pub mod macro_support {
     #[cfg(feature = "schemars08")]
     pub use schemars as schemars08;
@@ -664,37 +665,25 @@ mod proptest1_imp {
 /// If the `schemars08` feature is enabled, and [`JsonSchema`] is implemented for a kind `T`, then
 /// [`TypedUuid`]`<T>` will also implement [`JsonSchema`].
 ///
-/// # Notes
-///
-/// If you have a large number of UUID kinds, it can be repetitive to implement this trait for each
-/// kind. Here's a template for a macro that can help:
+/// If you have a large number of UUID kinds, consider using
+/// [`newtype-uuid-macros`] which comes with several convenience features.
 ///
 /// ```
-/// use newtype_uuid::{TypedUuidKind, TypedUuidTag};
-///
-/// macro_rules! impl_typed_uuid_kind {
-///     ($($kind:ident => $tag:literal),* $(,)?) => {
-///         $(
-///             pub enum $kind {}
-///
-///             impl TypedUuidKind for $kind {
-///                 #[inline]
-///                 fn tag() -> TypedUuidTag {
-///                     const TAG: TypedUuidTag = TypedUuidTag::new($tag);
-///                     TAG
-///                 }
-///             }
-///         )*
-///     };
-/// }
+/// use newtype_uuid_macros::impl_typed_uuid_kinds;
 ///
 /// // Invoke this macro with:
-/// impl_typed_uuid_kind! {
-///     Kind1 => "kind1",
-///     Kind2 => "kind2",
+/// impl_typed_uuid_kinds! {
+///     kinds = {
+///         User = {},
+///         Project = {},
+///         // ...
+///     },
 /// }
 /// ```
 ///
+/// See [`newtype-uuid-macros`] for more information.
+///
+/// [`newtype-uuid-macros`]: https://docs.rs/newtype-uuid-macros
 /// [`JsonSchema`]: schemars::JsonSchema
 pub trait TypedUuidKind: Send + Sync + 'static {
     /// Returns the corresponding tag for this kind.
@@ -704,10 +693,16 @@ pub trait TypedUuidKind: Send + Sync + 'static {
     /// The tag is required to be a static string.
     fn tag() -> TypedUuidTag;
 
-    /// Returns an alias for `TypedUuid<Self>`, if one is defined.
+    /// Returns a string that corresponds to a type alias for `TypedUuid<Self>`,
+    /// if one is defined.
+    ///
+    /// The type alias must be defined in the same module as `Self`. This
+    /// function is used by the schemars integration to refer to embed a
+    /// reference to that alias in the schema, if available.
+    ///
+    /// This is usually defined by the [`newtype-uuid-macros`] crate.
     ///
-    /// The alias must be defined in the same module as `Self`. This alias is
-    /// used by schemars integration to refer to `TypedUuid<Self>` if available.
+    /// [`newtype-uuid-macros`]: https://docs.rs/newtype-uuid-macros
     #[inline]
     fn alias() -> Option<&'static str> {
         None