[Erp5-report] r6869 - /erp5/trunk/products/ERP5/PropertySheet/
nobody at svn.erp5.org
nobody at svn.erp5.org
Mon Apr 24 10:46:11 CEST 2006
Author: vincent
Date: Mon Apr 24 10:46:08 2006
New Revision: 6869
URL: http://svn.erp5.org?rev=6869&view=rev
Log:
Improve coding style.
Improve docstrings.
Add descriptions to properties that misses them.
Add warnings on properties that should not be used.
Remove financial_year_stop_date from Organisation, because accounting period replaces it.
Modified:
erp5/trunk/products/ERP5/PropertySheet/Account.py
erp5/trunk/products/ERP5/PropertySheet/AccountingPreference.py
erp5/trunk/products/ERP5/PropertySheet/Alarm.py
erp5/trunk/products/ERP5/PropertySheet/Amortisation.py
erp5/trunk/products/ERP5/PropertySheet/AppliedRule.py
erp5/trunk/products/ERP5/PropertySheet/BusinessTemplate.py
erp5/trunk/products/ERP5/PropertySheet/DefaultSupply.py
erp5/trunk/products/ERP5/PropertySheet/GeographicAddress.py
erp5/trunk/products/ERP5/PropertySheet/MailMessage.py
erp5/trunk/products/ERP5/PropertySheet/Organisation.py
erp5/trunk/products/ERP5/PropertySheet/PaySheet.py
erp5/trunk/products/ERP5/PropertySheet/Person.py
erp5/trunk/products/ERP5/PropertySheet/Telephone.py
erp5/trunk/products/ERP5/PropertySheet/Url.py
Modified: erp5/trunk/products/ERP5/PropertySheet/Account.py
URL: http://svn.erp5.org/erp5/trunk/products/ERP5/PropertySheet/Account.py?rev=6869&r1=6868&r2=6869&view=diff
==============================================================================
--- erp5/trunk/products/ERP5/PropertySheet/Account.py (original)
+++ erp5/trunk/products/ERP5/PropertySheet/Account.py Mon Apr 24 10:46:08 2006
@@ -28,12 +28,15 @@
class Account:
"""
- Organisation properties and categories
+ Account properties and categories
"""
_properties = (
- { 'id' : 'is_credit_account',
- 'description' : 'Some account are',
+ { 'id' : 'is_credit_account', # XXX: this property should be
+ # named diferently : an account can
+ # be naturally debitor, creditor,
+ # or none of those
+ 'description' : 'Some accounts are',
'type' : 'boolean',
'mode' : 'w' ,
'default' : 0 },
Modified: erp5/trunk/products/ERP5/PropertySheet/AccountingPreference.py
URL: http://svn.erp5.org/erp5/trunk/products/ERP5/PropertySheet/AccountingPreference.py?rev=6869&r1=6868&r2=6869&view=diff
==============================================================================
--- erp5/trunk/products/ERP5/PropertySheet/AccountingPreference.py (original)
+++ erp5/trunk/products/ERP5/PropertySheet/AccountingPreference.py Mon Apr 24 10:46:08 2006
@@ -28,7 +28,9 @@
class AccountingPreference:
"""
- User Preferences for erp5_accounting
+ User Preferences for erp5_accounting.
+
+ Contains all preferences (see portal_preferences) relative to accounting.
"""
_properties = (
Modified: erp5/trunk/products/ERP5/PropertySheet/Alarm.py
URL: http://svn.erp5.org/erp5/trunk/products/ERP5/PropertySheet/Alarm.py?rev=6869&r1=6868&r2=6869&view=diff
==============================================================================
--- erp5/trunk/products/ERP5/PropertySheet/Alarm.py (original)
+++ erp5/trunk/products/ERP5/PropertySheet/Alarm.py Mon Apr 24 10:46:08 2006
@@ -29,6 +29,8 @@
class Alarm:
"""
Properties which allow to define a generic Alarm.
+
+ An alarm can be used to trigger an action periodically.
"""
_properties = (
Modified: erp5/trunk/products/ERP5/PropertySheet/Amortisation.py
URL: http://svn.erp5.org/erp5/trunk/products/ERP5/PropertySheet/Amortisation.py?rev=6869&r1=6868&r2=6869&view=diff
==============================================================================
--- erp5/trunk/products/ERP5/PropertySheet/Amortisation.py (original)
+++ erp5/trunk/products/ERP5/PropertySheet/Amortisation.py Mon Apr 24 10:46:08 2006
@@ -35,7 +35,6 @@
These properties are applied to an Immobilisation Movement or to an Item
TODO:
-
- rename categories for more genericity (input_acount -> input)
"""
Modified: erp5/trunk/products/ERP5/PropertySheet/AppliedRule.py
URL: http://svn.erp5.org/erp5/trunk/products/ERP5/PropertySheet/AppliedRule.py?rev=6869&r1=6868&r2=6869&view=diff
==============================================================================
--- erp5/trunk/products/ERP5/PropertySheet/AppliedRule.py (original)
+++ erp5/trunk/products/ERP5/PropertySheet/AppliedRule.py Mon Apr 24 10:46:08 2006
@@ -29,11 +29,16 @@
class AppliedRule:
"""
AppliedRule
+
+ An AppliedRule makes the link between simulation movements it contains
+ and the rule that generated them.
"""
_properties = (
{ 'id' : 'last_expand_simulation_state',
- 'description' : '',
+ 'description' : 'Contains the id of the simulation state when the '\
+ 'object was last expanded (in order to avoid '\
+ 'recalculation)',
'type' : 'string',
'mode' : 'w' },
)
Modified: erp5/trunk/products/ERP5/PropertySheet/BusinessTemplate.py
URL: http://svn.erp5.org/erp5/trunk/products/ERP5/PropertySheet/BusinessTemplate.py?rev=6869&r1=6868&r2=6869&view=diff
==============================================================================
--- erp5/trunk/products/ERP5/PropertySheet/BusinessTemplate.py (original)
+++ erp5/trunk/products/ERP5/PropertySheet/BusinessTemplate.py Mon Apr 24 10:46:08 2006
@@ -28,7 +28,10 @@
class BusinessTemplate:
"""
- Organisation properties and categories
+ Business templates properties and categories
+
+ A business template contains all zope objects needed to add a given
+ functionnality to ERP5, like accounting or pdf rendering.
"""
_properties = (
Modified: erp5/trunk/products/ERP5/PropertySheet/DefaultSupply.py
URL: http://svn.erp5.org/erp5/trunk/products/ERP5/PropertySheet/DefaultSupply.py?rev=6869&r1=6868&r2=6869&view=diff
==============================================================================
--- erp5/trunk/products/ERP5/PropertySheet/DefaultSupply.py (original)
+++ erp5/trunk/products/ERP5/PropertySheet/DefaultSupply.py Mon Apr 24 10:46:08 2006
@@ -34,10 +34,10 @@
_properties = (
{ 'id' : 'supply_line',
- 'storage_id' : 'default_supply_line',
+ 'storage_id' : 'default_supply_line',
'description' : '',
'type' : 'content',
- 'portal_type' : 'Supply Line',
+ 'portal_type' : 'Supply Line',
'acquired_property_id' : ('base_price','id','priced_quantity','price_currency',
'source','destination','quantity_step','priced_quantity',
'start_date','stop_date','start_date_range_max',
Modified: erp5/trunk/products/ERP5/PropertySheet/GeographicAddress.py
URL: http://svn.erp5.org/erp5/trunk/products/ERP5/PropertySheet/GeographicAddress.py?rev=6869&r1=6868&r2=6869&view=diff
==============================================================================
--- erp5/trunk/products/ERP5/PropertySheet/GeographicAddress.py (original)
+++ erp5/trunk/products/ERP5/PropertySheet/GeographicAddress.py Mon Apr 24 10:46:08 2006
@@ -33,15 +33,15 @@
_properties = (
{ 'id' : 'street_address',
- 'description' : '',
+ 'description' : 'Street address.',
'type' : 'string',
'mode' : 'w' },
{ 'id' : 'city',
- 'description' : '',
+ 'description' : 'City name.',
'type' : 'string',
'mode' : 'w' },
{ 'id' : 'zip_code',
- 'description' : '',
+ 'description' : 'Zip code.',
'type' : 'string',
'mode' : 'w' },
)
Modified: erp5/trunk/products/ERP5/PropertySheet/MailMessage.py
URL: http://svn.erp5.org/erp5/trunk/products/ERP5/PropertySheet/MailMessage.py?rev=6869&r1=6868&r2=6869&view=diff
==============================================================================
--- erp5/trunk/products/ERP5/PropertySheet/MailMessage.py (original)
+++ erp5/trunk/products/ERP5/PropertySheet/MailMessage.py Mon Apr 24 10:46:08 2006
@@ -34,32 +34,32 @@
_properties = (
{ 'id' : 'subject',
- 'description' : '',
+ 'description' : 'Mail subject, extracted from header.',
'type' : 'string',
'default' : '',
'mode' : 'w' },
{ 'id' : 'date',
- 'description' : '',
+ 'description' : 'Mail send date, extracted from header.',
'type' : 'string',
'mode' : 'w' },
{ 'id' : 'to',
- 'description' : '',
+ 'description' : 'Destination email address, extracted from header.',
'type' : 'string',
'mode' : 'w' },
{ 'id' : 'reply_to',
- 'description' : '',
+ 'description' : 'Reply to email address, extracted from header.',
'type' : 'string',
'mode' : 'w' },
{ 'id' : 'sender',
- 'description' : '',
+ 'description' : 'Sender email address, extracted from header.',
'type' : 'string',
'mode' : 'w' },
{ 'id' : 'body',
- 'description' : '',
+ 'description' : 'Mail body.',
'type' : 'text',
'mode' : 'w' },
{ 'id' : 'header',
- 'description' : '',
+ 'description' : 'Mail header as received.',
'type' : 'text',
'mode' : 'w' },
{ 'id' : 'other_info',
Modified: erp5/trunk/products/ERP5/PropertySheet/Organisation.py
URL: http://svn.erp5.org/erp5/trunk/products/ERP5/PropertySheet/Organisation.py?rev=6869&r1=6868&r2=6869&view=diff
==============================================================================
--- erp5/trunk/products/ERP5/PropertySheet/Organisation.py (original)
+++ erp5/trunk/products/ERP5/PropertySheet/Organisation.py Mon Apr 24 10:46:08 2006
@@ -102,7 +102,7 @@
# Acquisition
{ 'id' : 'address',
'storage_id' : 'default_address',
- 'description' : 'The organisations this persons works for',
+ 'description' : 'The default address of this organisations',
'type' : 'content',
'portal_type' : ('Address'),
'acquisition_base_category' : ('region', ),
@@ -141,7 +141,7 @@
'mode' : 'w' },
{ 'id' : 'fax',
'storage_id' : 'default_fax',
- 'description' : 'The organisations this persons works for',
+ 'description' : 'The defaut fax phone number for this organisation',
'type' : 'content',
'portal_type' : ('Fax'),
'acquisition_base_category' : ('region', ),
@@ -154,7 +154,7 @@
'mode' : 'w' },
{ 'id' : 'email',
'storage_id' : 'default_email',
- 'description' : 'The organisations this persons works for',
+ 'description' : 'The default email address for this organisation',
'type' : 'content',
'portal_type' : ('Email'),
'acquisition_base_category' : ('region', ),
@@ -165,15 +165,10 @@
'acquisition_accessor_id' : 'getDefaultEmailValue',
'acquisition_depends' : None,
'mode' : 'w' },
- # Amortisation
- { 'id' : 'financial_year_stop_date',
- 'description' : 'The date which ends the organisation financial year',
- 'type' : 'date',
- 'mode' : 'w' },
)
_categories = ( 'role', 'group', 'activity', 'skill', 'market_segment', 'region',
'social_form', 'function', 'source', 'destination', 'source_section',
'destination_section', 'price_currency', 'economical_class', 'site',
# Virtual Categories
- 'source_region', 'destination_region', )
+ 'source_region', 'destination_region', )
Modified: erp5/trunk/products/ERP5/PropertySheet/PaySheet.py
URL: http://svn.erp5.org/erp5/trunk/products/ERP5/PropertySheet/PaySheet.py?rev=6869&r1=6868&r2=6869&view=diff
==============================================================================
--- erp5/trunk/products/ERP5/PropertySheet/PaySheet.py (original)
+++ erp5/trunk/products/ERP5/PropertySheet/PaySheet.py Mon Apr 24 10:46:08 2006
@@ -32,15 +32,15 @@
"""
_properties = (
- { 'id' : 'gross_salary',
+ { 'id' : 'gross_salary', #XXX data duplication
'description' : '',
'type' : 'float',
'mode' : 'w' },
{ 'id' : 'work_duration',
- 'description' : '',
+ 'description' : 'Duration of work.',
'type' : 'date',
'mode' : 'w' },
- { 'id' : 'advantage',
+ { 'id' : 'advantage', #XXX data duplication
'description' : '',
'type' : 'float',
'mode' : 'w' },
Modified: erp5/trunk/products/ERP5/PropertySheet/Person.py
URL: http://svn.erp5.org/erp5/trunk/products/ERP5/PropertySheet/Person.py?rev=6869&r1=6868&r2=6869&view=diff
==============================================================================
--- erp5/trunk/products/ERP5/PropertySheet/Person.py (original)
+++ erp5/trunk/products/ERP5/PropertySheet/Person.py Mon Apr 24 10:46:08 2006
@@ -36,24 +36,24 @@
_properties = (
# Personnal properties
{ 'id' : 'password'
- , 'description': ''
+ , 'description': 'Cleartext password.'
, 'type' : 'string'
, 'write_permission' : 'Set own password'
, 'read_permission' : 'Manage users'
, 'mode' : 'w'
},
{ 'id' : 'first_name'
- , 'description': ''
+ , 'description': 'First name.'
, 'type' : 'string'
, 'mode' : 'w'
},
{ 'id' : 'last_name'
- , 'description': ''
+ , 'description': 'Last name.'
, 'type' : 'string'
, 'mode' : 'w'
},
{ 'id' : 'middle_name'
- , 'description': ''
+ , 'description': 'Middle name.'
, 'type' : 'string'
, 'mode' : 'w'
},
@@ -63,17 +63,17 @@
, 'mode' : 'w'
},
{ 'id' : 'prefix'
- , 'description': ''
+ , 'description': 'Name prefix.'
, 'type' : 'string'
, 'mode' : 'w'
},
{ 'id' : 'suffix'
- , 'description': ''
+ , 'description': 'Name suffix.'
, 'type' : 'string'
, 'mode' : 'w'
},
{ 'id' : 'birthday'
- , 'description': ''
+ , 'description': 'Date of birth.'
, 'type' : 'date'
, 'mode' : 'w'
},
@@ -83,12 +83,12 @@
, 'mode' : 'w'
},
{ 'id' : 'partner_count'
- , 'description': ''
+ , 'description': 'Number of familial partners.'
, 'type' : 'int'
, 'mode' : 'w'
},
{ 'id' : 'child_count'
- , 'description': ''
+ , 'description': 'Number of childs.'
, 'type' : 'int'
, 'mode' : 'w'
},
Modified: erp5/trunk/products/ERP5/PropertySheet/Telephone.py
URL: http://svn.erp5.org/erp5/trunk/products/ERP5/PropertySheet/Telephone.py?rev=6869&r1=6868&r2=6869&view=diff
==============================================================================
--- erp5/trunk/products/ERP5/PropertySheet/Telephone.py (original)
+++ erp5/trunk/products/ERP5/PropertySheet/Telephone.py Mon Apr 24 10:46:08 2006
@@ -29,23 +29,25 @@
class Telephone:
"""
Properties for Telephone Objects
+
+ Can be used for Fax numbers aswell.
"""
_properties = (
{ 'id' : 'telephone_country',
- 'description' : '',
+ 'description' : 'Country indicative number',
'type' : 'string',
'mode' : 'w' },
{ 'id' : 'telephone_area',
- 'description' : '',
+ 'description' : 'Area indicative number',
'type' : 'string',
'mode' : 'w' },
{ 'id' : 'telephone_number',
- 'description' : '',
+ 'description' : 'Telephone number minus indicatives',
'type' : 'string',
'mode' : 'w' },
{ 'id' : 'telephone_extension',
- 'description' : '',
+ 'description' : 'Telephone number extension',
'type' : 'string',
'mode' : 'w' },
)
Modified: erp5/trunk/products/ERP5/PropertySheet/Url.py
URL: http://svn.erp5.org/erp5/trunk/products/ERP5/PropertySheet/Url.py?rev=6869&r1=6868&r2=6869&view=diff
==============================================================================
--- erp5/trunk/products/ERP5/PropertySheet/Url.py (original)
+++ erp5/trunk/products/ERP5/PropertySheet/Url.py Mon Apr 24 10:46:08 2006
@@ -33,7 +33,7 @@
_properties = (
{ 'id' : 'url_string',
- 'description' : 'demo of url creation stuff within 15 minutes',
+ 'description' : 'url value',
'type' : 'string',
'mode' : 'w'
},
More information about the Erp5-report
mailing list