Commit 52cf4dde authored by Vincent Pelletier's avatar Vincent Pelletier

Improve coding style.

Improve docstrings.



git-svn-id: https://svn.erp5.org/repos/public/erp5/trunk@6870 20353a03-c40f-0410-a6d1-a30d3c3de9de
parent d3234d25
...@@ -26,9 +26,7 @@ ...@@ -26,9 +26,7 @@
# #
############################################################################## ##############################################################################
class Amount: class Amount:
""" """
An amount defines a quantity and variation of a resource An amount defines a quantity and variation of a resource
""" """
...@@ -26,11 +26,9 @@ ...@@ -26,11 +26,9 @@
# #
############################################################################## ##############################################################################
class Capacity: class Capacity:
""" """
A capacity is defined as a set of resources with quantities A capacity is defined as a set of resources with quantities
expressed in a standard unit expressed in a standard unit
""" """
pass pass
...@@ -26,10 +26,8 @@ ...@@ -26,10 +26,8 @@
# #
############################################################################## ##############################################################################
class Causality: class Causality:
""" """
A causality is contains movements generated by a template. A causality contains movements generated by a template.
""" """
pass pass
...@@ -26,10 +26,9 @@ ...@@ -26,10 +26,9 @@
# #
############################################################################## ##############################################################################
from Item import Item from Item import Item
class Container(Item): class Container(Item):
""" """
A container is a collection of Items (and Containers) A container is a collection of Items (and Containers)
""" """
...@@ -26,9 +26,7 @@ ...@@ -26,9 +26,7 @@
# #
############################################################################## ##############################################################################
class Delivery: class Delivery:
""" """
A Delivery object is a collection of movements A Delivery object is a collection of movements
""" """
...@@ -26,11 +26,10 @@ ...@@ -26,11 +26,10 @@
# #
############################################################################## ##############################################################################
class Item: class Item:
""" """
An Item defines a serial number and is referenced by an amount An Item defines a serial number and is referenced by an amount
or a movement (or a couple of). During transformations, a tracking or a movement (or a couple of). During transformations, a tracking
document can be produced to provide details between transformed items. document can be produced to provide details between transformed items.
""" """
...@@ -26,36 +26,32 @@ ...@@ -26,36 +26,32 @@
# #
############################################################################## ##############################################################################
class MetaNode: class MetaNode:
""" """
A metanode aggregates a collection of real nodes. A metanode aggregates a collection of real nodes.
It is used for planning and budgeting. It is used for planning and budgeting.
One application of a metanode is to create accounting rules.... One application of a metanode is to create accounting rules....
Ex. accounting Ex. accounting
source/coramy/accounting/4003 source/coramy/accounting/4003
destination/norfatex/accounting/2001 destination/norfatex/accounting/2001
resource: EUR resource: EUR
amount: 10.0 amount: 10.0
source/portal_categories/country/france/accounting/4003
destination/portal_categories/country/spain/accounting/2001
source/portal_categories/country/france/accounting/4003 resource: EUR
destination/portal_categories/country/spain/accounting/2001 amount: 10.0
resource: EUR This means that we may have to add some uid to movement table
amount: 10.0 if we wish to benefit from acquisition.
This means that we may have to add some uid to movement table """
if we wish to benefit from acquisition.
def getNodeList():
"""
Returns the subnodes of this metanode
""" """
def getNodeList():
"""
Returns the subnodes of this metanode
"""
...@@ -27,9 +27,9 @@ ...@@ -27,9 +27,9 @@
############################################################################## ##############################################################################
class MetaResource: class MetaResource:
""" """
A meta resource is an abstract resource which summarizes A meta resource is an abstract resource which summarizes
a collection of resources. a collection of resources.
Applicatino is : budgetting Application is : budgetting
""" """
...@@ -26,12 +26,10 @@ ...@@ -26,12 +26,10 @@
# #
############################################################################## ##############################################################################
class Movement: class Movement:
""" """
Movement of a quantity of resource in a given variation Movement of a quantity of resource in a given variation
from a source to a destination. Discrete variation from a source to a destination. Discrete variation
is stored as category. Continuous variation is stored is stored as category. Continuous variation is stored
as attribute. as attribute.
""" """
...@@ -26,9 +26,7 @@ ...@@ -26,9 +26,7 @@
# #
############################################################################## ##############################################################################
class Node: class Node:
""" """
People, machines, People, machines,
""" """
...@@ -27,9 +27,9 @@ ...@@ -27,9 +27,9 @@
############################################################################## ##############################################################################
class Path(Relation): class Path(Relation):
""" """
A path defines a planning path between two nodes A path defines a planning path between two nodes
source, destination, domain (which resource) source, destination, domain (which resource)
mapped value is : delivery, price etc. mapped value is : delivery, price etc.
""" """
...@@ -26,10 +26,8 @@ ...@@ -26,10 +26,8 @@
# #
############################################################################## ##############################################################################
class Prototype: class Prototype:
""" """
A transformed resource which can be extended A transformed resource which can be extended
All Transformations should be prototypes All Transformations should be prototypes
""" """
...@@ -26,9 +26,7 @@ ...@@ -26,9 +26,7 @@
# #
############################################################################## ##############################################################################
class Quantity: class Quantity:
""" """
Quantities are float in ERP5 Quantities are float in ERP5
""" """
...@@ -26,9 +26,7 @@ ...@@ -26,9 +26,7 @@
# #
############################################################################## ##############################################################################
class Resource: class Resource:
""" """
Describes a resource Describes a resource
""" """
...@@ -26,9 +26,7 @@ ...@@ -26,9 +26,7 @@
# #
############################################################################## ##############################################################################
class Rule: class Rule:
""" """
Implemented as a movement template in XSL approach Implemented as a movement template in XSL approach
""" """
...@@ -26,10 +26,8 @@ ...@@ -26,10 +26,8 @@
# #
############################################################################## ##############################################################################
class Tracking: class Tracking:
""" """
Points to items invoved in a transformation Points to items invoved in a transformation
(incl. identity transformation) (incl. identity transformation)
""" """
...@@ -26,10 +26,8 @@ ...@@ -26,10 +26,8 @@
# #
############################################################################## ##############################################################################
class Transformation: class Transformation:
""" """
Collectino of transformed resources Collection of transformed resources
""" """
pass pass
...@@ -26,9 +26,7 @@ ...@@ -26,9 +26,7 @@
# #
############################################################################## ##############################################################################
class Variation: class Variation:
""" """
Discrete variation Discrete variation
""" """
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment