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

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

diff --git a/blogo/metadata/metadata.go b/blogo/metadata/metadata.go
index 4309147..4dcbd2d 100644
--- a/blogo/metadata/metadata.go
+++ b/blogo/metadata/metadata.go
@@ -261,6 +261,17 @@ func (m Map) Delete(key string) error {
 	return nil
 }
 
+// Joins multiple [Metadata] objects together so their values can be easily
+// accessed using just one call.
+//
+// [Get]:
+// Iterates over all Metadatas until it finds one that returns a nil-error.
+//
+// [Set]:
+// Sets the specified key on all underlying Metadatas. Ignores errors.
+//
+// [Delete]:
+// Deletes the specified key on all underlying Metadatas. Ignores errors.
 func Join(ms ...Metadata) Metadata {
 	ms = append([]Metadata{Map(make(map[string]any))}, ms...)
 	return joined(ms)