fix typos for documentation

Closing the issue.

[Ian Wilson, 2009-09-08 08:55:37]

http://codereview.appspot.com/116055/diff/1/21
File trytond/model/modelview.py (right):

http://codereview.appspot.com/116055/diff/1/21#newcode110
Line 110: - fields: a dictionary with the definition of each fields in the view
fields-->field ?

[yangoon1, 2009-09-08 11:32:22]

just a first shot, to be continued.

http://codereview.appspot.com/116055/diff/1/2
File doc/models.rst (right):

http://codereview.appspot.com/116055/diff/1/2#newcode7
Line 7: Model is python classes that usually represents business logic or
Models are python classes that usually represent a business logic or a concept.

http://codereview.appspot.com/116055/diff/1/2#newcode10
Line 10: There is different kind of Model for different purpose:
There are different kinds of Models for different purposes:

http://codereview.appspot.com/116055/diff/1/2#newcode16
Line 16: * ``ModelSQL``: Define ModelStorage with SQL database for storage
backend.
...as storage backend.

http://codereview.appspot.com/116055/diff/1/2#newcode62
Line 62: Instantiating the class register the Model class in the framework.
... registers ...

http://codereview.appspot.com/116055/diff/1/2#newcode63
Line 63: Later they will be instantiated once per database and stored in the
Pool.
Later the classes ...

http://codereview.appspot.com/116055/diff/1/2#newcode64
Line 64: Model instances are essentially accessors to the records.
was better before ;)

http://codereview.appspot.com/116055/diff/1/2#newcode66
Line 66: Model properties defines meta-informations about the model, they are
... define meta-informations of the model, ...

http://codereview.appspot.com/116055/diff/1/2#newcode68
Line 68: Some Model Properties are instance attributes which allow to update
... attributes allowing to update ...

http://codereview.appspot.com/116055/diff/1/2#newcode101
Line 101: Simple clause is a list of conditions, with an implicit ``AND``
A simple clause...

http://codereview.appspot.com/116055/diff/1/2#newcode111
Line 111: More complex clause can be made this way:
... clauses ...

http://codereview.appspot.com/116055/diff/1/2#newcode123
Line 123: number *dots* in the left hand side of a condition is not limited, but
number of *dots*

http://codereview.appspot.com/116055/diff/1/2#newcode126
Line 126: Which if used in a search call on the Address model will result in
If used in a search call on the Address model this will result in

http://codereview.appspot.com/116055/diff/1/2#newcode129
Line 129: user.):
... user):

http://codereview.appspot.com/116055/diff/1/2#newcode188
Line 188: possible to create the two models without using inheritance because
inheritance, because

http://codereview.appspot.com/116055/diff/1/2#newcode189
Line 189: each of the foreign key (``first_owner`` and ``current_car``) need the
each of the foreign keys (``first_owner`` and ``current_car``) needs the

http://codereview.appspot.com/116055/diff/1/2#newcode222
Line 222: modified then `self._reset_columns` is called.  Also notice that a
developer should try
modified `self._reset_columns` is called.

http://codereview.appspot.com/116055/diff/1/2#newcode229
Line 229: Fields are class attributes which name can not start with an
underscore.
... with a name that can not ...

http://codereview.appspot.com/116055/diff/1/2#newcode332
Line 332: Let's say that the following field is defined on the invoice model:
Assuming the following ...

http://codereview.appspot.com/116055/diff/1/2#newcode366
Line 366: The first variant of this we'll look at is defining a unique function
for
The first variant we'll look at...

http://codereview.appspot.com/116055/diff/1/2#newcode422
Line 422: The framework is able to check if ``names`` (instead of ``name``) is
check, if

http://codereview.appspot.com/116055/diff/1/2#newcode450
Line 450: Another improvement would be to provide a search function.
Another possible improvement can be to provide...

http://codereview.appspot.com/116055/diff/1/2#newcode453
Line 453: ``total_service`` field, solution could be something like the
..., a solution could look like...

http://codereview.appspot.com/116055/diff/1/2#newcode494
Line 494: One should note that such an implementation would be very slow for a
large
Note: Such an...

http://codereview.appspot.com/116055/diff/1/2#newcode500
Line 500: It's also possible to allow the user to write on a function field:
It is...

[timitos, 2009-09-08 15:41:52]

good work. here are my suggestions.

http://codereview.appspot.com/116055/diff/25/26
File doc/models.rst (right):

http://codereview.appspot.com/116055/diff/25/26#newcode191
Line 191: each of the foreign key (``first_owner`` and ``current_car``) needs
the
each of the foreign keys (``first_owner`` and ``current_car``) need the

http://codereview.appspot.com/116055/diff/25/44
File trytond/model/modelstorage.py (right):

http://codereview.appspot.com/116055/diff/25/44#newcode395
Line 395: :return: a list of dictionaries or a dictionnary if limit is 1
dictionary

[yangoon1, 2009-09-08 23:45:32]

On 2009/09/08 15:41:52, timitos wrote:
> good work. here are my suggestions.
> 
> http://codereview.appspot.com/116055/diff/25/26
> File doc/models.rst (right):
> 
> http://codereview.appspot.com/116055/diff/25/26#newcode191
> Line 191: each of the foreign key (``first_owner`` and ``current_car``) needs
> the

each of the foreign keys ... needs 

> each of the foreign keys (``first_owner`` and ``current_car``) need the
> 
> http://codereview.appspot.com/116055/diff/25/44
> File trytond/model/modelstorage.py (right):
> 
> http://codereview.appspot.com/116055/diff/25/44#newcode395
> Line 395: :return: a list of dictionaries or a dictionnary if limit is 1

or a dictionary
> dictionary

[yangoon1, 2009-09-08 23:48:09]

> > http://codereview.appspot.com/116055/diff/25/44
> > File trytond/model/modelstorage.py (right):
> > 
> > http://codereview.appspot.com/116055/diff/25/44#newcode395
> > Line 395: :return: a list of dictionaries or a dictionnary if limit is 1
> 
> or a dictionary
> > dictionary

sorry, already written there, didn't understand...

[yangoon1, 2009-09-08 23:57:41]

I would appreciate a common handling of all doc strings, be it in classes or
functions.

-> full stop ("." at the end) after each sentence
-> all params descriptions either in lower case or in capital letters

There are some inconsistencies left, that I didn't mark.

Finished first review of all docs.

http://codereview.appspot.com/116055/diff/25/30
File trytond/model/fields/field.py (right):

http://codereview.appspot.com/116055/diff/25/30#newcode21
Line 21: ``readonly`` and ``invisible``. Values are string of python
Values are strings of python

http://codereview.appspot.com/116055/diff/25/30#newcode22
Line 22: statement that can be evaluated with record values. This allows to
statements, ...

http://codereview.appspot.com/116055/diff/25/30#newcode25
Line 25: :param change_default: A boolean if ``True`` the field can be used as
A boolean. If...

http://codereview.appspot.com/116055/diff/25/30#newcode26
Line 26: condition for custom default value.
a condition for a custom default value.

http://codereview.appspot.com/116055/diff/25/30#newcode27
Line 27: :param translate: A boolean if ``True`` the field is translatable.
A boolean. If ...

http://codereview.appspot.com/116055/diff/25/30#newcode29
Line 29: search box in list view and search will be optimized. When equal to
... and the search ...

http://codereview.appspot.com/116055/diff/25/31
File trytond/model/fields/float.py (right):

http://codereview.appspot.com/116055/diff/25/31#newcode18
Line 18: :param digits: a list of two intergers which define the total
...integers defining the total

http://codereview.appspot.com/116055/diff/25/31#newcode19
Line 19: of digit and the number of decimal for the float.
of digits and the number of decimals of the float.

http://codereview.appspot.com/116055/diff/25/34
File trytond/model/fields/many2many.py (right):

http://codereview.appspot.com/116055/diff/25/34#newcode25
Line 25: it allow to specify the order of result
allowing to specify...

http://codereview.appspot.com/116055/diff/25/34#newcode173
Line 173: Return the target model
Return the target model.

http://codereview.appspot.com/116055/diff/25/35
File trytond/model/fields/many2one.py (right):

http://codereview.appspot.com/116055/diff/25/35#newcode19
Line 19: :param model_name: The name of the targeted model
...model.

http://codereview.appspot.com/116055/diff/25/37
File trytond/model/fields/one2many.py (right):

http://codereview.appspot.com/116055/diff/25/37#newcode21
Line 21: :param add_remove: A list that defines a domain for the add/remove.
... domain on add/remove.

http://codereview.appspot.com/116055/diff/25/37#newcode25
Line 25: it allow to specify the order of result
allowing to specify the order of result.

http://codereview.appspot.com/116055/diff/25/37#newcode93
Line 93: :param values: A list of tuple:
... tuples:

http://codereview.appspot.com/116055/diff/25/38
File trytond/model/fields/property.py (right):

http://codereview.appspot.com/116055/diff/25/38#newcode11
Line 11: Define property field that is stored in ir.property (any).
Define a property field...

http://codereview.appspot.com/116055/diff/25/38#newcode20
Line 20: :param type: The type of field.
...of the field.

http://codereview.appspot.com/116055/diff/25/38#newcode21
Line 21: :param fnct_search: The name of the function to search.
... of the search function.

http://codereview.appspot.com/116055/diff/25/41
File trytond/model/fields/text.py (right):

http://codereview.appspot.com/116055/diff/25/41#newcode10
Line 10: 
no empty line here

http://codereview.appspot.com/116055/diff/25/42
File trytond/model/model.py (right):

http://codereview.appspot.com/116055/diff/25/42#newcode13
Line 13: :_name: a unique string to reference the model across all the platform.
... throughout the platform.

http://codereview.appspot.com/116055/diff/25/42#newcode14
Line 14: :_inherits:
:_inherits: a model from which this one inherits.

http://codereview.appspot.com/116055/diff/25/42#newcode422
Line 422: Raise an exception that will be display as a warning message
Raise an exception that will be displayed as a warning message

http://codereview.appspot.com/116055/diff/25/42#newcode423
Line 423: in the client if the user has not yet by-pass it.
in the client, if the user has not yet bypassed it.

http://codereview.appspot.com/116055/diff/25/42#newcode458
Line 458: Return a dict with the default values for each fields_names.
Return a dict with the default values for each field in fields_names.

http://codereview.appspot.com/116055/diff/25/42#newcode465
Line 465: :return: a dictionnary with field name as key
dictionary

http://codereview.appspot.com/116055/diff/25/42#newcode598
Line 598: Returns the definition of each field in the object.
Return the definition of each field in the object.

http://codereview.appspot.com/116055/diff/25/42#newcode602
Line 602: :param fields_names: a list of fields names or None for all fields
a list of field names or None for all fields

http://codereview.appspot.com/116055/diff/25/42#newcode604
Line 604: :return: a dictionnary with field name as key and definition as value
dictionary

http://codereview.appspot.com/116055/diff/25/43
File trytond/model/modelsql.py (right):

http://codereview.appspot.com/116055/diff/25/43#newcode18
Line 18: Define a model with storage in database in Tryton.
Define a model with storage in database.

http://codereview.appspot.com/116055/diff/25/43#newcode28
Line 28: must be sorted when sorting on this model from the other one.
... from an other model.

http://codereview.appspot.com/116055/diff/25/44
File trytond/model/modelstorage.py (right):

http://codereview.appspot.com/116055/diff/25/44#newcode227
Line 227: Duplicate the record in ids.
Duplicate the record(s) in ids.

http://codereview.appspot.com/116055/diff/25/44#newcode337
Line 337: Return a list of id that match the clauses defined in args.
Return a list of ids that match the clauses defined in args.

http://codereview.appspot.com/116055/diff/25/44#newcode342
Line 342: lists are construct like this:
constructed

http://codereview.appspot.com/116055/diff/25/44#newcode346
Line 346: tuples are construct like this:
constructed

http://codereview.appspot.com/116055/diff/25/44#newcode351
Line 351: :param offset: an integer to specify the offset for the result
offset of  the result.

http://codereview.appspot.com/116055/diff/25/44#newcode355
Line 355: it allow to specify the order of result
allowing to specify

http://codereview.appspot.com/116055/diff/25/44#newcode357
Line 357: :param count: a boolean to return only the len of the result
length

http://codereview.appspot.com/116055/diff/25/44#newcode366
Line 366: Return the number of record that match the domain. (See search)
records

http://codereview.appspot.com/116055/diff/25/44#newcode382
Line 382: Call search function and read in once.
Call search and read functions at once.

http://codereview.appspot.com/116055/diff/25/44#newcode383
Line 383: Usefull for the client to reduce the number of calls.
Useful to reduce the number of calls of the client

http://codereview.appspot.com/116055/diff/25/44#newcode389
Line 389: :param limit: an integer to specify the number of result
... number of records.

http://codereview.appspot.com/116055/diff/25/44#newcode390
Line 390: :param order: a list of tuple that are constructed like this:
tuples

http://codereview.appspot.com/116055/diff/25/44#newcode392
Line 392: it allow to specify the order of result
allowing to specify

http://codereview.appspot.com/116055/diff/25/44#newcode396
Line 396: the dictionaries will have fields names as key
field names

http://codereview.appspot.com/116055/diff/25/44#newcode397
Line 397: and fields value as value
field values

http://codereview.appspot.com/116055/diff/25/44#newcode566
Line 566: Return list of list of values for each ids.
Return list of list of values for each id in ids.

http://codereview.appspot.com/116055/diff/25/44#newcode567
Line 567: The list of values follow the fields_names.
follows fields_names.

http://codereview.appspot.com/116055/diff/25/44#newcode568
Line 568: Relational fields are defined with '/' at any deep.
... at any depth.

http://codereview.appspot.com/116055/diff/25/44#newcode572
Line 572: :param fields_names: a list of fields names
field names

http://codereview.appspot.com/116055/diff/25/44#newcode574
Line 574: :return: a list of list of values for each ids
each id in ids

http://codereview.appspot.com/116055/diff/25/44#newcode584
Line 584: Create record for each values in datas.
Create records for all values in datas.

http://codereview.appspot.com/116055/diff/25/44#newcode585
Line 585: The fields name of values must be defined in fields_names.
The field names of values must be defined in fields_names.

http://codereview.appspot.com/116055/diff/25/44#newcode590
Line 590: :param datas: the datas to import
the data to import

http://codereview.appspot.com/116055/diff/25/44#newcode786
Line 786: forbid all modification on records/fields originating from
forbid any modification

http://codereview.appspot.com/116055/diff/25/44#newcode794
Line 794: :param values: a dictionary with fields names as key and
field names

http://codereview.appspot.com/116055/diff/25/44#newcode828
Line 828: Function that check if there is no recursion in the tree
checks

http://codereview.appspot.com/116055/diff/25/44#newcode1068
Line 1068: Trigger trigger event.
Trigger a trigger event.

http://codereview.appspot.com/116055/diff/25/45
File trytond/model/modelview.py (right):

http://codereview.appspot.com/116055/diff/25/45#newcode105
Line 105: :param hexmd5: if fill, the function will return True if the result
filled

http://codereview.appspot.com/116055/diff/25/45#newcode106
Line 106: have the same md5
has

[ced1, 2009-09-09 17:06:24]

http://codereview.appspot.com/116055/diff/25/26
File doc/models.rst (right):

http://codereview.appspot.com/116055/diff/25/26#newcode7
Line 7: Models are python classes that usually represent a business logic or a
I think it is better to keep singular here.

http://codereview.appspot.com/116055/diff/25/26#newcode65
Line 65: Later the classes will be instantiated once per database and stored in
the Pool.
class can be singular

http://codereview.appspot.com/116055/diff/25/26#newcode68
Line 68: Model properties define meta-informations  of the model, they are
There is a double before "of"

[gour, 2009-09-10 16:37:41]

On 2009/09/08 23:57:41, yangoon wrote:
> I would appreciate a common handling of all doc strings, be it in classes or
> functions.

I agree...that's why I've started with this patch.

 
> -> full stop ("." at the end) after each sentence

I've tried to follow that.

> -> all params descriptions either in lower case or in capital letters
> 
> There are some inconsistencies left, that I didn't mark.

I also need to become more familiar with the system to tackle this stuff.

> 
> Finished first review of all docs.

Thank you.

I'm fixing it and will post another patch set soon.

[yangoon1, 2009-09-12 17:39:03]

http://codereview.appspot.com/116055/diff/52/1040
File doc/models.rst (right):

http://codereview.appspot.com/116055/diff/52/1040#newcode7
Line 7: Models are python classes that usually represent a business logic or a
Proposal:
A model is a python class that usually represents...

http://codereview.appspot.com/116055/diff/52/1053
File trytond/model/fields/reference.py (right):

http://codereview.appspot.com/116055/diff/52/1053#newcode35
Line 35: :param cursor: the database cursor
I think for the sake of consistency you should change all param strings to begin
with capital letters. There are also others e.g. in trytond/model/model*.py .
Thx for reviewing again all params for this issue.

http://codereview.appspot.com/116055/diff/52/1056
File trytond/model/model.py (right):

http://codereview.appspot.com/116055/diff/52/1056#newcode13
Line 13: :_name: a unique string to reference the model throughout the platform.
Those strings IMHO should also begin with capital letters.
-> A unique string...
etc.

[ced1, 2009-09-12 18:19:23]

http://codereview.appspot.com/116055/diff/52/1053
File trytond/model/fields/reference.py (right):

http://codereview.appspot.com/116055/diff/52/1053#newcode35
Line 35: :param cursor: the database cursor
On 2009/09/12 17:39:04, yangoon wrote:
> I think for the sake of consistency you should change all param strings to
begin
> with capital letters. There are also others e.g. in trytond/model/model*.py .
> Thx for reviewing again all params for this issue.

I don't find it is necessary

[ced1, 2009-09-28 09:28:35]

It must be finished soon if you want it in 1.4

[yangoon1, 2009-09-28 13:02:56]

On 2009/09/28 09:28:35, ced wrote:
> It must be finished soon if you want it in 1.4

You applied already in http://bugs.tryton.org/roundup/issue1161 .

I think issue can be closed.

[ced1, 2009-10-13 12:33:48]

Can be closed

[ced1, 2009-11-13 11:36:07]

On 2009/10/13 12:33:48, ced wrote:
> Can be closed

Please gour close it!