From 85840faf70a091d09fd45fdfe0233abf1fa95700 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Sybren=20A=2E=20St=C3=BCvel?= <sybren@stuvel.eu>
Date: Thu, 22 Mar 2018 10:10:50 +0100
Subject: [PATCH] Added docstring

---
 blender_asset_tracer/pack/__init__.py | 14 ++++++++++++++
 1 file changed, 14 insertions(+)

diff --git a/blender_asset_tracer/pack/__init__.py b/blender_asset_tracer/pack/__init__.py
index f4fd699..1923996 100644
--- a/blender_asset_tracer/pack/__init__.py
+++ b/blender_asset_tracer/pack/__init__.py
@@ -79,6 +79,20 @@ class Aborted(RuntimeError):
 
 
 class Packer:
+    """Takes a blend file and bundle it with its dependencies.
+
+    The process is separated into two functions:
+
+        - strategise() finds all the dependencies and determines what to do
+          with them.
+        - execute() performs the actual packing operation, by rewriting blend
+          files to ensure the paths to moved files are correct, and
+          transferring the files.
+
+    The file transfer is performed in a separate thread, by a FileTransferer
+    instance.
+    """
+
     def __init__(self,
                  bfile: pathlib.Path,
                  project: pathlib.Path,