From 6cab51fe64b4bc32dc090cc2813fc459ca54bfd1 Mon Sep 17 00:00:00 2001 From: Tatuya Kamada <tatuya@nexedi.com> Date: Fri, 5 Apr 2013 18:08:32 +0900 Subject: [PATCH] docstring: Update Movement Group docstring as what the movement group is about. --- .../ERP5/Document/BaseVariantMovementGroup.py | 4 ++-- .../ERP5/Document/RequirementMovementGroup.py | 4 ++-- product/ERP5/Document/SplitMovementGroup.py | 20 +++++++++++++++++-- product/ERP5/Document/TitleMovementGroup.py | 4 ++-- product/ERP5/Document/VariantMovementGroup.py | 4 ++-- 5 files changed, 26 insertions(+), 10 deletions(-) diff --git a/product/ERP5/Document/BaseVariantMovementGroup.py b/product/ERP5/Document/BaseVariantMovementGroup.py index d16dd953a4..4b64c5d36a 100644 --- a/product/ERP5/Document/BaseVariantMovementGroup.py +++ b/product/ERP5/Document/BaseVariantMovementGroup.py @@ -29,8 +29,8 @@ from Products.ERP5.Document.MovementGroup import MovementGroup class BaseVariantMovementGroup(MovementGroup): """ - The purpose of MovementGroup is to define how movements are grouped, - and how values are updated from simulation movements. + This movement group is used to group movements that have the same + base category list, without assining it. """ meta_type = 'ERP5 Base Variant Movement Group' portal_type = 'Base Variant Movement Group' diff --git a/product/ERP5/Document/RequirementMovementGroup.py b/product/ERP5/Document/RequirementMovementGroup.py index 156ebb9418..4a8f643440 100644 --- a/product/ERP5/Document/RequirementMovementGroup.py +++ b/product/ERP5/Document/RequirementMovementGroup.py @@ -29,8 +29,8 @@ from Products.ERP5.Document.MovementGroup import MovementGroup class RequirementMovementGroup(MovementGroup): """ - The purpose of MovementGroup is to define how movements are grouped, - and how values are updated from simulation movements. + This movement group is used to group movements that have the same + requirement. """ meta_type = 'ERP5 Requirement Movement Group' portal_type = 'Requirement Movement Group' diff --git a/product/ERP5/Document/SplitMovementGroup.py b/product/ERP5/Document/SplitMovementGroup.py index d35609cf0c..152e8b9cdc 100644 --- a/product/ERP5/Document/SplitMovementGroup.py +++ b/product/ERP5/Document/SplitMovementGroup.py @@ -29,8 +29,24 @@ from Products.ERP5.Document.MovementGroup import MovementGroup class SplitMovementGroup(MovementGroup): """ - The purpose of MovementGroup is to define how movements are grouped, - and how values are updated from simulation movements. + This movement group is used to split all the movements that are aggregated + by the Simulation Select Method. + + XXX-Tatuya: However this test() method returns True, so the aggregated + movements can be inserted into existing Delivery/Line/Cell that are aggregated + by the Delivery Select Method. What use case this is applied for? + + * Reference: + http://www.erp5.org/HowToConfigureMovementGroup + + test(self, object, property_dict, **kw): + (mandatory) + This method returns if object can be used for updating according to + property_dict. Its return value is [updatable? (True or False), + property_dict that is used to update values]. If you want to create a + new Delivery/Line/Cell instead of updating existing one, + return [False, property_dict]. + """ meta_type = 'ERP5 Split Movement Group' portal_type = 'Split Movement Group' diff --git a/product/ERP5/Document/TitleMovementGroup.py b/product/ERP5/Document/TitleMovementGroup.py index 0169c65b6d..d1bbc49e5a 100644 --- a/product/ERP5/Document/TitleMovementGroup.py +++ b/product/ERP5/Document/TitleMovementGroup.py @@ -29,8 +29,8 @@ from Products.ERP5.Document.MovementGroup import MovementGroup class TitleMovementGroup(MovementGroup): """ - The purpose of MovementGroup is to define how movements are grouped, - and how values are updated from simulation movements. + This movement group is used to group movements that have the same + title. """ meta_type = 'ERP5 Title Movement Group' portal_type = 'Title Movement Group' diff --git a/product/ERP5/Document/VariantMovementGroup.py b/product/ERP5/Document/VariantMovementGroup.py index 042a5d52d4..ea6f18b42a 100644 --- a/product/ERP5/Document/VariantMovementGroup.py +++ b/product/ERP5/Document/VariantMovementGroup.py @@ -29,8 +29,8 @@ from Products.ERP5.Document.MovementGroup import MovementGroup class VariantMovementGroup(MovementGroup): """ - The purpose of MovementGroup is to define how movements are grouped, - and how values are updated from simulation movements. + This movement group is used to group movements that have the same + variation category list. """ meta_type = 'ERP5 Variant Movement Group' portal_type = 'Variant Movement Group' -- 2.30.9