Added docstring

This commit is contained in:
Sybren A. Stüvel 2018-03-22 10:10:50 +01:00
parent 8d1bd89583
commit 85840faf70

View File

@ -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,