From 0fc05525576bb3778ca1b62e28a615fa5ab88050 Mon Sep 17 00:00:00 2001
From: "Claas j. Gramann" <claas.j.gramann@gmail.com>
Date: Tue, 23 Apr 2024 09:46:44 +0200
Subject: [PATCH] Add doc example for default type parameters

---
 specs-derive/src/lib.rs | 12 +++++++++++-
 1 file changed, 11 insertions(+), 1 deletion(-)

diff --git a/specs-derive/src/lib.rs b/specs-derive/src/lib.rs
index 9ac5c0b51..139f4c9ee 100644
--- a/specs-derive/src/lib.rs
+++ b/specs-derive/src/lib.rs
@@ -28,7 +28,17 @@ mod impl_saveload;
 /// use specs::storage::VecStorage;
 ///
 /// #[derive(Component, Debug)]
-/// #[storage(VecStorage)] // This line is optional, defaults to `DenseVecStorage`
+/// #[storage(VecStorage<Self>)] // This line is optional, defaults to `DenseVecStorage<Self>`
+/// struct Pos(f32, f32, f32);
+/// ```
+///
+/// When the type parameter is `<Self>` it can be omitted i.e.:
+///
+///```rust,ignore
+/// use specs::storage::VecStorage;
+///
+/// #[derive(Component, Debug)]
+/// #[storage(VecStorage)] // Equals to #[storage(VecStorage<Self>)]
 /// struct Pos(f32, f32, f32);
 /// ```
 #[proc_macro_derive(Component, attributes(storage))]