From cc1531aaf732d13306be56540c9f5b6942491c59 Mon Sep 17 00:00:00 2001
From: madlabman <10616301+madlabman@users.noreply.github.com>
Date: Wed, 24 Apr 2024 10:36:28 +0200
Subject: [PATCH] chore: add a note about pinning

---
 src/providers/ipfs/types.py | 5 +++--
 1 file changed, 3 insertions(+), 2 deletions(-)

diff --git a/src/providers/ipfs/types.py b/src/providers/ipfs/types.py
index fa61a23a8..a21b70e23 100644
--- a/src/providers/ipfs/types.py
+++ b/src/providers/ipfs/types.py
@@ -11,7 +11,7 @@ class NotFound(Exception):
 
 
 class IPFSProvider(ABC):
-    """Interface for all implementations of an IPFS provider"""
+    """Interface for all implementations of an [IPFS](https://docs.ipfs.tech) provider"""
 
     @abstractmethod
     def fetch(self, cid: CIDv0 | CIDv1) -> bytes: ...
@@ -20,4 +20,5 @@ def fetch(self, cid: CIDv0 | CIDv1) -> bytes: ...
     def upload(self, content: bytes, name: str | None = None) -> CIDv0 | CIDv1: ...
 
     @abstractmethod
-    def pin(self, cid: CIDv0 | CIDv1) -> None: ...
+    def pin(self, cid: CIDv0 | CIDv1) -> None:
+        """Pin the content, see https://docs.ipfs.tech/how-to/pin-files"""