Commits

wd15  committed d7d7565

Add documentation for `Project.backup`.

  • Participants
  • Parent commits 00d3378
  • Branches record-store-conversion-no-json

Comments (0)

Files changed (1)

File sumatra/projects.py

         return new_label, original.label
 
     def backup(self):
+        """        
+        Create a new backup directory in the same location as the
+        project directory and copy the contents of the project
+        directory into the backup directory. Uses `_get_project_file`
+        to extract the path to the project directory.
+        
+        :return:
+          - `backup_dir`: the directory used for the backup
+
+        """
         import shutil
         from datetime import datetime
         smt_dir = os.path.split(_get_project_file(self.path))[0]