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

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

diff --git a/blogo/metadata/metadata.go b/blogo/metadata/metadata.go
index 4dcbd2d..d287402 100644
--- a/blogo/metadata/metadata.go
+++ b/blogo/metadata/metadata.go
@@ -305,6 +305,8 @@ func (m joined) Delete(key string) error {
 
 type immutable struct{ Metadata }
 
+// Converts all keys from m to immutable. All calls to Set and Delete
+// are responded with [ErrImmutable].
 func Immutable(m Metadata) Metadata {
 	return &immutable{m}
 }