Skip to content

Commit 69f7542

Browse files
committed
More documentation for the Types
1 parent bcdc3e9 commit 69f7542

File tree

1 file changed

+5
-2
lines changed

1 file changed

+5
-2
lines changed

partitionmanager/types.py

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -403,7 +403,8 @@ def __eq__(self, other):
403403

404404
class ChangePlannedPartition(PlannedPartition):
405405
"""
406-
Represents modifications to a given Partition
406+
Represents modifications to a Partition supplied during construction. Use
407+
the parent class' methods to alter this change.
407408
"""
408409

409410
def __init__(self, old_part):
@@ -434,7 +435,9 @@ def __str__(self):
434435

435436
class NewPlannedPartition(PlannedPartition):
436437
"""
437-
Represents a wholly new Partition to be constructed
438+
Represents a wholly new Partition to be constructed. After construction,
439+
you must set the number of columns using set_columns before attempting
440+
to use this in a plan.
438441
"""
439442

440443
def __init__(self):

0 commit comments

Comments
 (0)