[IMP] : Update Description for modules

bzr revid: cha@tinyerp.com-20120713105030-jbl2mm81j6cyjake

addons/share/__openerp__.py

@@ -35,8 +35,8 @@ It specifically adds a 'share' button that is available in the Web client to
 share any kind of OpenERP data with colleagues, customers, friends.
 
 The system will work by creating new users and groups on the fly, and by
-combining the appropriate access rights and ir.rules to ensure that the
-shared users only have access to the data that has been shared with them.
+combining the appropriate access rights and ir.rules to ensure that the shared
+users only have access to the data that has been shared with them.
 
 This is extremely useful for collaborative work, knowledge sharing,
 synchronization with other companies.

addons/stock_invoice_directly/__openerp__.py

@@ -28,8 +28,8 @@
 Invoice Wizard for Delivery.
 ============================
 
-When you send or deliver goods, this module automatically launch
-the invoicing wizard if the delivery is to be invoiced.
+When you send or deliver goods, this module automatically launch the invoicing
+wizard if the delivery is to be invoiced.
     """,
     'author': 'OpenERP SA',
     'website': 'http://www.openerp.com',

addons/stock_location/__openerp__.py

@@ -38,51 +38,59 @@ Typically this could be used to:
 
     * Help rental management, by generating automated return moves for rented products
 
-Once this module is installed, an additional tab appear on the product form, where you can add
-Push and Pull flow specifications. The demo data of CPU1 product for that push/pull :
-
-Push flows
-----------
-Push flows are useful when the arrival of certain products in a given location should always
-be followed by a corresponding move to another location, optionally after a certain delay.
-The original Warehouse application already supports such Push flow specifications on the
-Locations themselves, but these cannot be refined per-product.
-
-A push flow specification indicates which location is chained with which location, and with
-what parameters. As soon as a given quantity of products is moved in the source location,
-a chained move is automatically foreseen according to the parameters set on the flow specification
-(destination location, delay, type of move, journal.) The new move can be automatically
-processed, or require a manual confirmation, depending on the parameters.
-
-Pull flows
-----------
-Pull flows are a bit different from Push flows, in the sense that they are not related to
-the processing of product moves, but rather to the processing of procurement orders.
-What is being pulled is a need, not directly products.
-A classical example of Pull flow is when you have an Outlet company, with a parent Company
-that is responsible for the supplies of the Outlet.
+Once this module is installed, an additional tab appear on the product form,
+where you can add Push and Pull flow specifications. The demo data of CPU1
+product for that push/pull :
+
+Push flows:
+-----------
+
+Push flows are useful when the arrival of certain products in a given location
+should always be followed by a corresponding move to another location, optionally
+after a certain delay. The original Warehouse application already supports such
+Push flow specifications on the Locations themselves, but these cannot be
+refined per-product.
+
+A push flow specification indicates which location is chained with which location,
+and with what parameters. As soon as a given quantity of products is moved in the
+source location, a chained move is automatically foreseen according to the
+parameters set on the flow specification (destination location, delay, type of
+move, journal.) The new move can be automatically processed, or require a manual
+confirmation, depending on the parameters.
+
+Pull flows:
+-----------
+
+Pull flows are a bit different from Push flows, in the sense that they are not
+related to the processing of product moves, but rather to the processing of
+procurement orders. What is being pulled is a need, not directly products. A
+classical example of Pull flow is when you have an Outlet company, with a parent
+Company that is responsible for the supplies of the Outlet.
 
   [ Customer ] <- A - [ Outlet ]  <- B -  [ Holding ] <~ C ~ [ Supplier ]
 
-When a new procurement order (A, coming from the confirmation of a Sale Order for example) arrives
-in the Outlet, it is converted into another procurement (B, via a Pull flow of type 'move')
-requested from the Holding. When procurement order B is processed by the Holding company, and
-if the product is out of stock, it can be converted into a Purchase Order (C) from the Supplier
-(Pull flow of type Purchase). The result is that the procurement order, the need, is pushed
+When a new procurement order (A, coming from the confirmation of a Sale Order
+for example) arrives in the Outlet, it is converted into another procurement
+(B, via a Pull flow of type 'move') requested from the Holding. When procurement
+order B is processed by the Holding company, and if the product is out of stock,
+it can be converted into a Purchase Order (C) from the Supplier (Pull flow of
+type Purchase). The result is that the procurement order, the need, is pushed
 all the way between the Customer and Supplier.
 
-Technically, Pull flows allow to process procurement orders differently, not only depending on
-the product being considered, but also depending on which location holds the "need" for that
-product (i.e. the destination location of that procurement order).
+Technically, Pull flows allow to process procurement orders differently, not
+only depending on the product being considered, but also depending on which
+location holds the "need" for that product (i.e. the destination location of
+that procurement order).
 
-Use-Case
---------
+Use-Case:
+---------
 
 You can use the demo data as follow:
   CPU1: Sell some CPU1 from Shop 1 and run the scheduler
      - Warehouse: delivery order, Shop 1: reception
   CPU3:
-     - When receiving the product, it goes to Quality Control location then stored to shelf 2.
+     - When receiving the product, it goes to Quality Control location then
+       stored to shelf 2.
      - When delivering the customer: Pick List -> Packing -> Delivery Order from Gate A
     """,
     'author': 'OpenERP SA',

addons/stock_no_autopicking/__openerp__.py

@@ -29,9 +29,9 @@ This module allows an intermediate picking process to provide raw materials to p
 =================================================================================================
 
 One example of usage of this module is to manage production made by your
-suppliers (sub-contracting). To achieve this, set the assembled product
-which is sub-contracted to "No Auto-Picking" and put the location of the
-supplier in the routing of the assembly operation.
+suppliers (sub-contracting). To achieve this, set the assembled product which is
+sub-contracted to "No Auto-Picking" and put the location of the supplier in the
+routing of the assembly operation.
     """,
     'author': 'OpenERP SA',
     'depends': ['mrp'],

addons/subscription/__openerp__.py

@@ -32,7 +32,8 @@ This module allows to create new documents and add subscriptions on that documen
 
 e.g. To have an invoice generated automatically periodically:
     * Define a document type based on Invoice object
-    * Define a subscription whose source document is the document defined as above. Specify the interval information and partner to be invoice.
+    * Define a subscription whose source document is the document defined as
+      above. Specify the interval information and partner to be invoice.
     """,
     'author': 'OpenERP SA',
     'depends': ['base_tools'],

addons/survey/__openerp__.py

@@ -27,10 +27,11 @@
 This module is used for surveying.
 ==================================
 
-It depends on the answers or reviews of some questions by different users.
-A survey may have multiple pages. Each page may contain multiple questions and each question may have multiple answers.
-Different users may give different answers of question and according to that survey is done.
-Partners are also sent mails with user name and password for the invitation of the survey
+It depends on the answers or reviews of some questions by different users. A
+survey may have multiple pages. Each page may contain multiple questions and each
+question may have multiple answers. Different users may give different answers of
+question and according to that survey is done. Partners are also sent mails with
+user name and password for the invitation of the survey.
     """,
     'author': 'OpenERP SA',
     'depends': ['base_tools', 'mail'],

addons/users_ldap/__openerp__.py

@@ -27,89 +27,77 @@
     "description": """
 Adds support for authentication by LDAP server.
 ===============================================
-This module allows users to login with their LDAP username and
-password, and will automatically create OpenERP users for them
-on the fly.
-
-**Note**: This module only work on servers who have Python's
-``ldap`` module installed.
-
-Configuration
-+++++++++++++
-After installing this module, you need to configure the LDAP
-parameters in the Configuration tab of the Company details.
-Different companies may have different LDAP servers, as long
-as they have unique usernames (usernames need to be unique in
-OpenERP, even across multiple companies).
-
-Anonymous LDAP binding is also supported (for LDAP servers
-that allow it), by simpling keeping the LDAP user and password
-empty in the LDAP configuration. This does **not** allow
-anonymous authentication for users, it is only for the master
-LDAP account that is used to verify if a user exists before
-attempting to authenticate it.
-
-Securing the connection with STARTTLS is available for LDAP
-servers supporting it, by enabling the TLS option in the LDAP
-configuration.
-
-For further options configuring the LDAP settings, refer to the
-ldap.conf manpage: manpage:`ldap.conf(5)`.
-
-Security Considerations
-+++++++++++++++++++++++
-Users' LDAP passwords are never stored in the OpenERP database,
-the LDAP server is queried whenever a user needs to be
-authenticated. No duplication of the password occurs, and
-passwords are managed in one place only.
-
-OpenERP does not manage password changes in the LDAP, so
-any change of password should be conducted by other means
-in the LDAP directory directly (for LDAP users).
-
-It is also possible to have local OpenERP users in the
-database along with LDAP-authenticated users (the Administrator
-account is one obvious example).
+This module allows users to login with their LDAP username and password, and
+will automatically create OpenERP users for them on the fly.
+
+Note: This module only work on servers who have Python's ``ldap`` module
+      installed.
+
+Configuration:
+--------------
+After installing this module, you need to configure the LDAP parameters in the
+Configuration tab of the Company details. Different companies may have different
+LDAP servers, as long as they have unique usernames (usernames need to be unique
+in OpenERP, even across multiple companies).
+
+Anonymous LDAP binding is also supported (for LDAP servers that allow it), by
+simpling keeping the LDAP user and password empty in the LDAP configuration.
+This does not allow anonymous authentication for users, it is only for the master
+LDAP account that is used to verify if a user exists before attempting to
+authenticate it.
+
+Securing the connection with STARTTLS is available for LDAP servers supporting
+it, by enabling the TLS option in the LDAP configuration.
+
+For further options configuring the LDAP settings, refer to the ldap.conf
+manpage: manpage:`ldap.conf(5)`.
+
+Security Considerations:
+------------------------
+Users' LDAP passwords are never stored in the OpenERP database, the LDAP server
+is queried whenever a user needs to be authenticated. No duplication of the
+password occurs, and passwords are managed in one place only.
+
+OpenERP does not manage password changes in the LDAP, so any change of password
+should be conducted by other means in the LDAP directory directly (for LDAP users).
+
+It is also possible to have local OpenERP users in the database along with
+LDAP-authenticated users (the Administrator account is one obvious example).
 
 Here is how it works:
 
-  * The system first attempts to authenticate users against
-    the local OpenERP database ;
-  * if this authentication fails (for example because the
-    user has no local password), the system then attempts
-    to authenticate against LDAP ;
-
-As LDAP users have blank passwords by default in the local
-OpenERP database (which means no access), the first step
-always fails and the LDAP server is queried to do the
-authentication.
-
-Enabling STARTTLS ensures that the authentication query to the
-LDAP server is encrypted.
-
-User Template
-+++++++++++++
-In the LDAP configuration on the Company form, it is possible to
-select a *User Template*. If set, this user will be used as
-template to create the local users whenever someone authenticates
-for the first time via LDAP authentication.
-This allows pre-setting the default groups and menus of the
-first-time users.
-
-**Warning**: if you set a password for the user template,
-this password will be assigned as local password for each new
-LDAP user, effectively setting a *master password* for these
-users (until manually changed). You usually do not want this.
-One easy way to setup a template user is to login once with
-a valid LDAP user, let OpenERP create a blank local user with the
-same login (and a blank password), then rename this new user
-to a username that does not exist in LDAP, and setup its
-groups the way you want.
-
-Interaction with base_crypt
-+++++++++++++++++++++++++++
-The base_crypt module is not compatible with this module, and
-will disable LDAP authentication if installed at the same time.
+    * The system first attempts to authenticate users against the local OpenERP
+      database;
+    * if this authentication fails (for example because the user has no local
+      password), the system then attempts to authenticate against LDAP;
+
+As LDAP users have blank passwords by default in the local OpenERP database
+(which means no access), the first step always fails and the LDAP server is
+queried to do the authentication.
+
+Enabling STARTTLS ensures that the authentication query to the LDAP server is
+encrypted.
+
+User Template:
+--------------
+In the LDAP configuration on the Company form, it is possible to select a *User
+Template*. If set, this user will be used as template to create the local users
+whenever someone authenticates for the first time via LDAP authentication. This
+allows pre-setting the default groups and menus of the first-time users.
+
+Warning: if you set a password for the user template, this password will be
+         assigned as local password for each new LDAP user, effectively setting
+         a *master password* for these users (until manually changed). You
+         usually do not want this. One easy way to setup a template user is to
+         login once with a valid LDAP user, let OpenERP create a blank local
+         user with the same login (and a blank password), then rename this new
+         user to a username that does not exist in LDAP, and setup its groups
+         the way you want.
+
+Interaction with base_crypt:
+----------------------------
+The base_crypt module is not compatible with this module, and will disable LDAP
+authentication if installed at the same time.
 
     """,