From 0726ff52a5379a60bda2a7a161d90255b3df0631 Mon Sep 17 00:00:00 2001 From: Sandy Walsh Date: Tue, 27 May 2014 01:45:13 +0000 Subject: [PATCH] fix docs to reflect kwargs constructors --- README.md | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 6ad58f0..e88810e 100644 --- a/README.md +++ b/README.md @@ -22,16 +22,20 @@ Roll Managers also take care of filename creation, compression of completed archives and transfer of archive files to remote storage locations. -The RollChecker's have a reference to the current Archive so +The RollCheckers have a reference to the current Archive so they can ask file-related questions (like "how big are you?") You can register callbacks with the RollManager for notifications on when new Archive files are opened or closed. +Important Note! The Callback handlers and the RollCheckers take +kwargs in the constructor since they can be dynamically loaded as +plugins. So, make sure you provide named parameters to the constructors. + Usage: # Make a roll checker of whatever strategy you choose. - checker = roll_checker.SizeRollChecker(100) # 100mb files + checker = roll_checker.SizeRollChecker(roll_size_mb=100) # 100mb files # Make a roll manager for reading or writing. # Give the filename template and the checker.