From c33bd3805314d7f7ad291bea4e23d6a9f9369021 Mon Sep 17 00:00:00 2001
From: "Gustavo L de Mello (Guz)" <contact@guz.one>
Date: Fri, 24 Jan 2025 16:41:12 -0300
Subject: [PATCH] docs(blogo,metadata): Map documentation

---
 blogo/metadata/metadata.go | 3 +++
 1 file changed, 3 insertions(+)

diff --git a/blogo/metadata/metadata.go b/blogo/metadata/metadata.go
index 266e222..4309147 100644
--- a/blogo/metadata/metadata.go
+++ b/blogo/metadata/metadata.go
@@ -228,6 +228,9 @@ type Metadata interface {
 	Delete(key string) error
 }
 
+// Type adapter to allow the use of ordinary maps as [Metadata] implementations.
+//
+// If map is nil, Get always returns [ErrNotFound], Set and Delete return [ErrImmutable].
 type Map map[string]any
 
 func (m Map) Get(key string) (any, error) {