From 5945391941571f7ff3f18c3d8249c00a89896254 Mon Sep 17 00:00:00 2001
From: Reda Laanait <laanait.reda@gmail.com>
Date: Mon, 9 Sep 2024 10:51:20 +0100
Subject: [PATCH] add comment to Props method

---
 gen/gen.go | 3 +--
 schema.go  | 2 ++
 2 files changed, 3 insertions(+), 2 deletions(-)

diff --git a/gen/gen.go b/gen/gen.go
index 379730c..05e3e1b 100644
--- a/gen/gen.go
+++ b/gen/gen.go
@@ -463,6 +463,5 @@ type field struct {
 	Doc           string
 	AvroFieldName string
 	Tags          map[string]TagStyle
-
-	Props map[string]any
+	Props         map[string]any
 }
diff --git a/schema.go b/schema.go
index e922392..d2b93df 100644
--- a/schema.go
+++ b/schema.go
@@ -366,6 +366,8 @@ func (p properties) Prop(name string) any {
 	return p.props[name]
 }
 
+// Props returns a map that contains all schema custom properties.
+// Any accidental change to the returned map will directly modify the schema custom properties.
 func (p properties) Props() map[string]any {
 	return p.props
 }