chore: add a note about pinning

lidofinance · Apr 24, 2024 · cc1531a · cc1531a
1 parent a4a10f1
commit cc1531a
Showing 1 changed file with 3 additions and 2 deletions.
diff --git 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"""