First snapshot of trytond documentation refactoring

[h.goebel, 2010-04-10 19:16:37]

Where is eg. unittests.rst gone?

http://codereview.appspot.com/907042/diff/1/2
File INSTALL (right):

http://codereview.appspot.com/907042/diff/1/2#newcode4
INSTALL:4: See doc/installation.rst
doc/installation.rst is *empty*

http://codereview.appspot.com/907042/diff/1/6
File doc/index.rst (right):

http://codereview.appspot.com/907042/diff/1/6#newcode24
doc/index.rst:24: First steps
I suggest using a sucture like
- Administration
  - Installation
  - Configuration
    - Users and Permissions
    - Installing Modules
    - ...
  - Upgrade / Update
- Customize and Extend Tryton
  - Write your own Modules
  - THe model Layer
  - The view Layer
- Develop Tryton

This is what administrators typically want:
install the software, see what is required to customize the installation, and
then maybe/hopefully develop Tryron :-)

NB: I do *not* expect all these topics to be written yet.

[yangoon1, 2010-04-10 20:45:22]

Finally it seems a little bit more hard atm to find specific pages. I would
appreciate a Table fo Contents showing more levels (not only the content of the
current selected page).

http://codereview.appspot.com/907042/diff/1/4
File doc/conf.py (right):

http://codereview.appspot.com/907042/diff/1/4#newcode178
doc/conf.py:178: u'Bertrand Chenal, Cédric Krier', 'manual'),
There are meanwhile several contributors to the documentation. They should be
credited in a fashionable way.

http://codereview.appspot.com/907042/diff/1/6
File doc/index.rst (right):

http://codereview.appspot.com/907042/diff/1/6#newcode10
doc/index.rst:10: * Looking for specific information? Try the :ref:`genindex`,
:ref:`modindex` or
genindex and modindex provide the same content. I think one of them is
sufficient.

http://codereview.appspot.com/907042/diff/1/6#newcode11
doc/index.rst:11: the :ref:`table of contents <contents>`.
Table of Contents

http://codereview.appspot.com/907042/diff/1/6#newcode13
doc/index.rst:13: * Search information in the `mailing list`_.
Mailing List

http://codereview.appspot.com/907042/diff/1/6#newcode17
doc/index.rst:17: * Report issues with trytond on `issue tracker`_.
on the `Issue Tracker`_.

http://codereview.appspot.com/907042/diff/1/16
File doc/topics/install.rst (right):

http://codereview.appspot.com/907042/diff/1/16#newcode26
doc/topics/install.rst:26: You've got three easy options to install Tryton:
only two options below

What about option to run from sources (could include a link to the wiki)?

http://codereview.appspot.com/907042/diff/1/16#newcode28
doc/topics/install.rst:28: * Install the version provided by your operating
system distribution. This
Install the version provided by the distribution of your operating system.

http://codereview.appspot.com/907042/diff/1/16#newcode30
doc/topics/install.rst:30: that distribute Tryton.
This is the most quick and recommended option for users running a distribution
providing the installation of Tryton by its package management system.

http://codereview.appspot.com/907042/diff/1/17
File doc/topics/models/index.rst (right):

http://codereview.appspot.com/907042/diff/1/17#newcode11
doc/topics/models/index.rst:11: a single database tables.
table.

http://codereview.appspot.com/907042/diff/1/17#newcode45
doc/topics/models/index.rst:45: _name = "relationship.party"
party.party

http://codereview.appspot.com/907042/diff/1/18
File doc/topics/models/model.rst (right):

http://codereview.appspot.com/907042/diff/1/18#newcode9
doc/topics/models/model.rst:9: This is the class that every kinds of model
inherits. It defines common
This is the class that each kind of model inherits.

http://codereview.appspot.com/907042/diff/1/18#newcode10
doc/topics/models/model.rst:10: attributes between all models:
It defines common attributes of all models:

http://codereview.appspot.com/907042/diff/1/18#newcode19
doc/topics/models/model.rst:19: remotely. If the value is ``True`` then the
transaction will be commited.
committed

http://codereview.appspot.com/907042/diff/1/18#newcode22
doc/topics/models/model.rst:22: message. Per example::
By way of example:

http://codereview.appspot.com/907042/diff/1/24
File doc/topics/modules/index.rst (right):

http://codereview.appspot.com/907042/diff/1/24#newcode8
doc/topics/modules/index.rst:8: comes by default with only a few functionality
included in those modules:
with the basic functionality

http://codereview.appspot.com/907042/diff/1/24#newcode92
doc/topics/modules/index.rst:92: The Python files defines the Models for the
modules.
define

http://codereview.appspot.com/907042/diff/1/24#newcode97
doc/topics/modules/index.rst:97: The XML files defines data that will be
inserted into the database.
define

http://codereview.appspot.com/907042/diff/1/24#newcode101
doc/topics/modules/index.rst:101: The following snippet gives a first idea of
what looks a xml file:
of what an xml file looks:

http://codereview.appspot.com/907042/diff/1/24#newcode145
doc/topics/modules/index.rst:145: attributes ``noupdate`` to prevent the
framework to update the records.
It can have the attribute ``noupdate`` to prevent the framework to update the
records.

What about skiptest?

http://codereview.appspot.com/907042/diff/1/24#newcode159
doc/topics/modules/index.rst:159: * ``ref``: Only for relation field, it
contains a xml id of the
an xml

http://codereview.appspot.com/907042/diff/1/24#newcode161
doc/topics/modules/index.rst:161: a ending dot, if the record is defined in an
other module.
an ending

[yangoon1, 2010-04-11 11:28:32]

What about my comment:
There are meanwhile several contributors to the documentation. They should be
credited in a fashionable way.?

http://codereview.appspot.com/907042/diff/12001/13014
File doc/topics/install.rst (right):

http://codereview.appspot.com/907042/diff/12001/13014#newcode29
doc/topics/install.rst:29: is the quickest and recommended option for those who
has operating system
still wrong

http://codereview.appspot.com/907042/diff/12001/13016
File doc/topics/models/model.rst (right):

http://codereview.appspot.com/907042/diff/12001/13016#newcode12
doc/topics/models/model.rst:12: This is the base class that every kinds of model
inherits. It defines common
still wrong

http://codereview.appspot.com/907042/diff/12001/13016#newcode71
doc/topics/models/model.rst:71: client, if the user has not yer bypassed it.
``warning_name`` is used to
not yet

http://codereview.appspot.com/907042/diff/12001/13016#newcode73
doc/topics/models/model.rst:73: :meth:`Model.raise_user_error`.
Other parameters

what about raise_exception?

[ced, 2010-04-14 05:46:09]

http://codereview.appspot.com/907042/diff/12001/13014
File doc/topics/install.rst (right):

http://codereview.appspot.com/907042/diff/12001/13014#newcode29
doc/topics/install.rst:29: is the quickest and recommended option for those who
has operating system
On 2010/04/11 11:28:32, yangoon wrote:
> still wrong
I don't see what is wrong.

http://codereview.appspot.com/907042/diff/12001/13016
File doc/topics/models/model.rst (right):

http://codereview.appspot.com/907042/diff/12001/13016#newcode12
doc/topics/models/model.rst:12: This is the base class that every kinds of model
inherits. It defines common
On 2010/04/11 11:28:32, yangoon wrote:
> still wrong
I don't see what is wrong.

http://codereview.appspot.com/907042/diff/12001/13016#newcode73
doc/topics/models/model.rst:73: :meth:`Model.raise_user_error`.
On 2010/04/11 11:28:32, yangoon wrote:
> Other parameters
> 
> what about raise_exception?
I don't understand.

[yangoon1, 2010-04-14 10:03:33]

http://codereview.appspot.com/907042/diff/12001/13014
File doc/topics/install.rst (right):

http://codereview.appspot.com/907042/diff/12001/13014#newcode29
doc/topics/install.rst:29: is the quickest and recommended option for those who
has operating system
On 2010/04/14 05:46:10, ced wrote:
> On 2010/04/11 11:28:32, yangoon wrote:
> > still wrong
> I don't see what is wrong.

'for those who have an operating system' would be correct, but not very
readable. I propose something like 'running an operating system...'

http://codereview.appspot.com/907042/diff/12001/13016
File doc/topics/models/model.rst (right):

http://codereview.appspot.com/907042/diff/12001/13016#newcode12
doc/topics/models/model.rst:12: This is the base class that every kinds of model
inherits. It defines common
On 2010/04/14 05:46:10, ced wrote:
> On 2010/04/11 11:28:32, yangoon wrote:
> > still wrong
> I don't see what is wrong.
> 

(every kind of model|all kinds of models)

http://codereview.appspot.com/907042/diff/12001/13016#newcode73
doc/topics/models/model.rst:73: :meth:`Model.raise_user_error`.
On 2010/04/14 05:46:10, ced wrote:
> On 2010/04/11 11:28:32, yangoon wrote:
> > Other parameters
> > 
> > what about raise_exception?
> I don't understand.
> 
Others parameters are like in :meth:`Model.raise_user_error`. : but there
doesn't seem to be parameter raise_exception for raise_user_warning

[yangoon1, 2010-04-20 10:25:25]

http://codereview.appspot.com/907042/diff/19001/20016
File doc/topics/models/model.rst (right):

http://codereview.appspot.com/907042/diff/19001/20016#newcode12
doc/topics/models/model.rst:12: This is the base class that every kinds of model
inherits. It defines common
still wrong

[udono, 2010-04-27 11:40:00]

Some comments and additions ahead. I get some warnings when 
$ make html
sphinx-build -b html -d _build/doctrees   . _build/html
Making output directory...
Running Sphinx v0.6.3
loading pickled environment... not found
building [html]: targets for 12 source files that are out of date
updating environment: 12 added, 0 changed, 0 removed
reading sources... [100%] topics/views/index                              
looking for now-outdated files... none found
pickling environment... done
checking consistency... done
preparing documents... done
writing output... [100%] topics/views/index                               
/home/uspallek/workspace/tryton/tip/trytond/doc/index.rst:10: WARNING: undefined
label: contents
/home/uspallek/workspace/tryton/tip/trytond/doc/index.rst:41: WARNING: undefined
label: topics-extension
/home/uspallek/workspace/tryton/tip/trytond/doc/ref/models/models.rst:267:
WARNING: undefined label: topics-workflow
/home/uspallek/workspace/tryton/tip/trytond/doc/ref/models/models.rst:358:
WARNING: undefined label: topics-workflow
/home/uspallek/workspace/tryton/tip/trytond/doc/ref/models/models.rst:362:
WARNING: undefined label: topics-workflow
/home/uspallek/workspace/tryton/tip/trytond/doc/ref/models/models.rst:366:
WARNING: undefined label: topics-workflow
/home/uspallek/workspace/tryton/tip/trytond/doc/ref/models/models.rst:370:
WARNING: undefined label: topics-workflow
/home/uspallek/workspace/tryton/tip/trytond/doc/topics/models/index.rst:16:
WARNING: undefined label: topics-fields
/home/uspallek/workspace/tryton/tip/trytond/doc/topics/models/index.rst:37:
WARNING: undefined label: topics-pool
writing additional files... genindex modindex search
copying static files... WARNING: static directory
'/home/uspallek/workspace/tryton/tip/trytond/doc/_static' does not exist
done
dumping search index... done
dumping object inventory... done
build succeeded, 10 warnings.

Build finished. The HTML pages are in _build/html.

http://codereview.appspot.com/907042/diff/50001/42005
File doc/index.rst (right):

http://codereview.appspot.com/907042/diff/50001/42005#newcode27
doc/index.rst:27: * **Installation**
Installation_:_

http://codereview.appspot.com/907042/diff/50001/42005#newcode29
doc/index.rst:29: 
* Modules documentation is a first step, too. Because a user always want to
learn the use of the modules functionality.

http://codereview.appspot.com/907042/diff/50001/42005#newcode51
doc/index.rst:51: * **Modules**
Modules_:_

http://codereview.appspot.com/907042/diff/50001/42005#newcode53
doc/index.rst:53: 
For me we should divide the modules documentation for the different audience. A
standard documentation get from modulename/doc/index.rst for a user audience,
and an api documentation get from modulname/doc/api.rst for the api and modeling
informations for a developer audience.

For me the user audience is only related to the modules part of trytond
documentation and the client documentation.
Install and maintenance is related to a admin audience.

The rest of the documentation is developer related. (Here we could have in
future two audiences like module developer and framework developer.)

http://codereview.appspot.com/907042/diff/50001/42013
File doc/ref/models/fields.rst (right):

http://codereview.appspot.com/907042/diff/50001/42013#newcode78
doc/ref/models/fields.rst:78: .. attribute:: Field.priority
.. attribute:: Field.change_default

http://codereview.appspot.com/907042/diff/50001/42013#newcode106
doc/ref/models/fields.rst:106: The on_change_<field name> methods are run in a
rollbacked transaction.
This means the cursor is not committed when leaving those methods.

http://codereview.appspot.com/907042/diff/50001/42013#newcode125
doc/ref/models/fields.rst:125: The on_change_with_<field name> methods are run
in a rollbacked transaction.
This means the cursor is not committed when leaving those methods.

http://codereview.appspot.com/907042/diff/50001/42013#newcode134
doc/ref/models/fields.rst:134: A list of field name on which this one depends.
This means that the client will
field name_s_

http://codereview.appspot.com/907042/diff/50001/42013#newcode135
doc/ref/models/fields.rst:135: also read those fields even if they are not
defined on the view.
This means that the client will read at first the given fields even if they are
not defined on the view.

http://codereview.appspot.com/907042/diff/50001/42013#newcode136
doc/ref/models/fields.rst:136: This is used per example to ensure that
:class:`~trytond.pyson.PYSON` statement
``Field.depends`` is used for example...

http://codereview.appspot.com/907042/diff/50001/42013#newcode153
doc/ref/models/fields.rst:153: A dictionary which will update the current
context when opening a relation
*relation field*

Make it italic, since it is a tryton expression for a special kind of fields.

http://codereview.appspot.com/907042/diff/50001/42013#newcode165
doc/ref/models/fields.rst:165: The client represents this as a checkbox.
this _field_ as a checkbox

http://codereview.appspot.com/907042/diff/50001/42013#newcode172
doc/ref/models/fields.rst:172: A integer field.
The client represents this field as a entry box restricted to numbers.

http://codereview.appspot.com/907042/diff/50001/42013#newcode179
doc/ref/models/fields.rst:179: A long integer field.
The client represents this field as a entry box restricted to numbers.

http://codereview.appspot.com/907042/diff/50001/42013#newcode188
doc/ref/models/fields.rst:188: :class:`Char` has two extra optional arguments:
The client represents this field as a entry box restricted to a single line.

http://codereview.appspot.com/907042/diff/50001/42013#newcode209
doc/ref/models/fields.rst:209: 
The client represents this field as a password entry box which show its value
hidden as dots.

http://codereview.appspot.com/907042/diff/50001/42013#newcode215
doc/ref/models/fields.rst:215: A multi line string field.
The client represents this field as a text box.

http://codereview.appspot.com/907042/diff/50001/42013#newcode234
doc/ref/models/fields.rst:234: 
The client represents this field as a entry box restricted to a single line of
numbers, decimal separator and plus or minus letter.

http://codereview.appspot.com/907042/diff/50001/42013#newcode250
doc/ref/models/fields.rst:250: 
The client represents this field as a entry box restricted to a single line of
numbers, decimal separator and plus or minus letter.

http://codereview.appspot.com/907042/diff/50001/42013#newcode263
doc/ref/models/fields.rst:263: 
The client represents this field as a entry box restricted to a date in the
given locale and a date picker.

http://codereview.appspot.com/907042/diff/50001/42013#newcode270
doc/ref/models/fields.rst:270: 
The client represents this field as a entry box restricted to a date ad time in
the given locale and a date picker.

http://codereview.appspot.com/907042/diff/50001/42013#newcode277
doc/ref/models/fields.rst:277: 
The client represents this field as a entry box restricted to a time.

http://codereview.appspot.com/907042/diff/50001/42013#newcode284
doc/ref/models/fields.rst:284: 
The client represents this field as a entry box with buttons for upload,
download and delete its content.

http://codereview.appspot.com/907042/diff/50001/42013#newcode291
doc/ref/models/fields.rst:291: 
The client represents this field as a selection box restricted to the given
options.

http://codereview.appspot.com/907042/diff/50001/42013#newcode296
doc/ref/models/fields.rst:296: A list of 2-tuples that looks like this::
An option list...

http://codereview.appspot.com/907042/diff/50001/42013#newcode307
doc/ref/models/fields.rst:307: list. The signature of the method is::
...return the option list...

http://codereview.appspot.com/907042/diff/50001/42013#newcode335
doc/ref/models/fields.rst:335: 
The client represents this field as a entry box with buttons for open/search its
content and for adding new content.

http://codereview.appspot.com/907042/diff/50001/42013#newcode350
doc/ref/models/fields.rst:350: 
The client represents this field as a entry box with buttons for open/search its
content and for adding new content.

http://codereview.appspot.com/907042/diff/50001/42013#newcode383
doc/ref/models/fields.rst:383: ``SET NULL`` will be changed into ``RESTRICT`` if
... will be override by the framework ...

http://codereview.appspot.com/907042/diff/50001/42013#newcode390
doc/ref/models/fields.rst:390: field name of the record.
It is usually used in combination with ModelSQL._history to request a value for
a given date and time in a historicized[1] model.

[1] http://www.merriam-webster.com/dictionary/historicized

http://codereview.appspot.com/907042/diff/50001/42013#newcode399
doc/ref/models/fields.rst:399: 
The client represents this field as a flat tree (or table, list) with buttons
for open/search/delete its content and for adding new content. Also buttons for
navigation and change form and list view are available.

http://codereview.appspot.com/907042/diff/50001/42013#newcode453
doc/ref/models/fields.rst:453: 
The client represents this field as a tree (flat or nested table) with buttons
for add and remove its content.

http://codereview.appspot.com/907042/diff/50001/42013#newcode469
doc/ref/models/fields.rst:469: For :class:`Many2Many` field on simple
:class:`~trytond.model.ModelView`,
For :class:`Many2Many` field on simple :class:`~trytond.model.ModelView`, 

like used in wizards,

...

http://codereview.appspot.com/907042/diff/50001/42015
File doc/ref/models/models.rst (right):

http://codereview.appspot.com/907042/diff/50001/42015#newcode10
doc/ref/models/models.rst:10: This is the base class that every kind of model
inherits. It defines common
Backref model to .. _topics-models:

http://codereview.appspot.com/907042/diff/50001/42015#newcode11
doc/ref/models/models.rst:11: attributes of all models.
in .. _topics-models: you name the attribute property. For me it is better to
give them one and only one name.

http://codereview.appspot.com/907042/diff/50001/42015#newcode18
doc/ref/models/models.rst:18: platform.
Here would be a small introduction of the syntax helpfull like: The _name
attribute contains lowercase letters separated by a dot or underscore, e.g.
``_name = "account.invoice.payment_term.line.type"``

see also: .. attribute:: ModelSQL._table 

And a word about inheritence with equal model _name in different modules would
be helpful.

http://codereview.appspot.com/907042/diff/50001/42015#newcode20
doc/ref/models/models.rst:20: .. attribute:: Model._inherits
It contains a dictionary with inherited ``Model._name`` as key and a field name
string of the given model as value. ``Model._inherits`` is used for a is-a[1]
{or better has-a?[2]} relationship of two models, where the given model is
extended by the inherited models attributes. E.g.::

    _inherits = {'timesheet.work': 'work'}


[1] http://en.wikipedia.org/wiki/Is-a
[2] http://en.wikipedia.org/wiki/Has-a

http://codereview.appspot.com/907042/diff/50001/42015#newcode45
doc/ref/models/models.rst:45: It contains the name of the field used as name of
records.
It is used when a model itself does not provide a ``name`` field or when the
record name needs to be different than the ``name`` field of the given model.

http://codereview.appspot.com/907042/diff/50001/42015#newcode55
doc/ref/models/models.rst:55: Register the model in ``ir.model`` and
``ir.model.field``.
Model.init is used for model specific migrations from one version to another.

http://codereview.appspot.com/907042/diff/50001/42015#newcode71
doc/ref/models/models.rst:71: :meth:`Model.raise_user_error`.
.. warning::

    It only works when the cursor is committed before
``Model.raise_user_warning`` is called. So ``Model.raise_user_warning`` will not
work as expected in methods like on_change_ and on_change_with_.
..

http://codereview.appspot.com/907042/diff/50001/42015#newcode95
doc/ref/models/models.rst:95: .. method:: ModelView.fields_view_get(cursor,
user, [view_id, [view_type, [context, [toolbar, [hexmd5]]]]])
why not use the api definitions from model.modelview.fields_view_get.__doc__?

http://codereview.appspot.com/907042/diff/50001/42015#newcode124
doc/ref/models/models.rst:124: Return the window title used by the client for
the specific view type.
Return the window title _as a string_

http://codereview.appspot.com/907042/diff/50001/42015#newcode197
doc/ref/models/models.rst:197: If ids is an integer, the returned value will be
a dictionary.
If ids is an *integer* or *long*

http://codereview.appspot.com/907042/diff/50001/42015#newcode201
doc/ref/models/models.rst:201: Write ``values`` on records. ``ids`` can be a
list of ids or an id.
... can be a list of ids or an id as *integer* or *long*.

http://codereview.appspot.com/907042/diff/50001/42015#newcode207
doc/ref/models/models.rst:207: Delete records. ``ids`` can be a list of ids or
an id.
... can be a list of ids or an id as *integer* or *long*.

http://codereview.appspot.com/907042/diff/50001/42015#newcode211
doc/ref/models/models.rst:211: Duplicate the records. ``ids`` can be a list of
ids or an id. ``default``
... can be a list of ids or an id as *integer* or *long*.

http://codereview.appspot.com/907042/diff/50001/42015#newcode276
doc/ref/models/models.rst:276: It implement :class:`ModelStorage` for an SQL
database.
for _a_ SQL database

.. warning::

Be aware of the multi database ability of Tryton. Try to avoid database system
specific SQL expressions and use instead <SQL which is provided by all databases
== AnsiSQL?>.
..

http://codereview.appspot.com/907042/diff/50001/42019
File doc/topics/install.rst (right):

http://codereview.appspot.com/907042/diff/50001/42019#newcode4
doc/topics/install.rst:4: Howt to install Tryton
How to

http://codereview.appspot.com/907042/diff/50001/42020
File doc/topics/models/index.rst (right):

http://codereview.appspot.com/907042/diff/50001/42020#newcode9
doc/topics/models/index.rst:9: a single database table.
> Most of the time, each model stores data in a single database table.
Maybe better:

A model can store data persistent in a database table.
http://en.wikipedia.org/wiki/Persistence_%28computer_science%29

http://codereview.appspot.com/907042/diff/50001/42020#newcode24
doc/topics/models/index.rst:24: This example model defines a ``Party`` which has
a ``name`` and a ``code``::
This example defines a ``Party`` model which has ``name`` and ``code`` fields::

http://codereview.appspot.com/907042/diff/50001/42020#newcode44
doc/topics/models/index.rst:44: attributes allowing to update them at other
places in the framework.
What about the _name property? Is it not mandatory for tryton models?

http://codereview.appspot.com/907042/diff/50001/42021
File doc/topics/modules/index.rst (right):

http://codereview.appspot.com/907042/diff/50001/42021#newcode50
doc/topics/modules/index.rst:50: * ``xml``: The list of the XML files of the
module. They will be loaded at
They will be loaded _in the given order_ at...

http://codereview.appspot.com/907042/diff/50001/42021#newcode168
doc/topics/modules/index.rst:168: 
..note::
Field values are usually evaluated as string. For integers it is needed to
eval() the values ao the field. E.g. use this footprint::
    <field name="sequence" eval="10"/>
instead of this::
    <field name="sequence">10</field>
..

[udono, 2010-04-27 12:05:42]

http://codereview.appspot.com/907042/diff/50001/42004
File doc/conf.py (right):

http://codereview.appspot.com/907042/diff/50001/42004#newcode43
doc/conf.py:43: copyright = u'2008-2010, Bertrand Chenal, Cédric Krier'
copyright = u'2008-2010 by Tryton Project'
encourages authors more.

Additional it is usual to let an author put his name in the authors tag under
the headline of a document. See
http://docutils.sourceforge.net/docs/user/rst/quickref.html#field-lists

[udono, 2010-04-27 12:26:01]

ask for autodoc and transform TODOs to sphinx.ext.todo

http://codereview.appspot.com/907042/diff/50001/42004
File doc/conf.py (right):

http://codereview.appspot.com/907042/diff/50001/42004#newcode27
doc/conf.py:27: extensions = ['sphinx.ext.todo']
why not use autodoc? For now we have a lot of redundant docs.

http://codereview.appspot.com/907042/diff/50001/42022
File doc/topics/reports/index.rst (right):

http://codereview.appspot.com/907042/diff/50001/42022#newcode54
doc/topics/reports/index.rst:54: .. TODO
.. todo::

write section Python API

http://codereview.appspot.com/907042/diff/50001/42022#newcode176
doc/topics/reports/index.rst:176: TODO: Explain the steps necessary to do this.
.. todo::

Explain the steps necessary to do Creating a simple report template for a model
from client

http://codereview.appspot.com/907042/diff/50001/42022#newcode220
doc/topics/reports/index.rst:220: 
.. todo::

Examples of overriding Report.execute.

http://codereview.appspot.com/907042/diff/50001/42022#newcode248
doc/topics/reports/index.rst:248: 
.. todo::

Explanation of how to override `ir.report.get_style_content` to change the
default style.

[ced, 2010-04-27 17:47:38]

On 2010/04/27 12:05:42, udono wrote:
> http://codereview.appspot.com/907042/diff/50001/42004
> File doc/conf.py (right):
> 
> http://codereview.appspot.com/907042/diff/50001/42004#newcode43
> doc/conf.py:43: copyright = u'2008-2010, Bertrand Chenal, Cédric Krier'
> copyright = u'2008-2010 by Tryton Project'
> encourages authors more.

We deal copyright on documentation like the copyright of the code

> 
> Additional it is usual to let an author put his name in the authors tag under
> the headline of a document. See
> http://docutils.sourceforge.net/docs/user/rst/quickref.html#field-lists

I prefer only one place like for the code

[udono, 2010-04-28 11:50:23]

http://codereview.appspot.com/907042/diff/50001/42015
File doc/ref/models/models.rst (right):

http://codereview.appspot.com/907042/diff/50001/42015#newcode378
doc/ref/models/models.rst:378: Modify :class:`ModelStorage` into a singleton.
add link to http://en.wikipedia.org/wiki/Singleton_pattern

[ced, 2010-04-28 17:58:58]

http://codereview.appspot.com/907042/diff/50001/42005
File doc/index.rst (right):

http://codereview.appspot.com/907042/diff/50001/42005#newcode27
doc/index.rst:27: * **Installation**
On 2010/04/27 11:40:01, udono wrote:
> Installation_:_

???

http://codereview.appspot.com/907042/diff/50001/42005#newcode53
doc/index.rst:53: 
On 2010/04/27 11:40:01, udono wrote:
> For me we should divide the modules documentation for the different audience.
A
> standard documentation get from modulename/doc/index.rst for a user audience,
> and an api documentation get from modulname/doc/api.rst for the api and
modeling
> informations for a developer audience.
> 
> For me the user audience is only related to the modules part of trytond
> documentation and the client documentation.
> Install and maintenance is related to a admin audience.
> 
> The rest of the documentation is developer related. (Here we could have in
> future two audiences like module developer and framework developer.)

It is not modules documentation.

http://codereview.appspot.com/907042/diff/50001/42013
File doc/ref/models/fields.rst (right):

http://codereview.appspot.com/907042/diff/50001/42013#newcode106
doc/ref/models/fields.rst:106: The on_change_<field name> methods are run in a
rollbacked transaction.
On 2010/04/27 11:40:01, udono wrote:
> This means the cursor is not committed when leaving those methods.

It is the same.

[timitos, 2010-04-29 07:21:26]

http://codereview.appspot.com/907042/diff/50001/42013
File doc/ref/models/fields.rst (right):

http://codereview.appspot.com/907042/diff/50001/42013#newcode8
doc/ref/models/fields.rst:8: Fields defines the behaviors of the data on model's
record.
Fields define the behavior of the data on model's record.

http://codereview.appspot.com/907042/diff/50001/42013#newcode21
doc/ref/models/fields.rst:21: A string for label of the field.
A string for the label of the field.

http://codereview.appspot.com/907042/diff/50001/42013#newcode42
doc/ref/models/fields.rst:42: If ``True``, the field is not editable in the
client. Defautl is ``False``.
Default

http://codereview.appspot.com/907042/diff/50001/42013#newcode49
doc/ref/models/fields.rst:49: A :ref:`domain <topics-domain>` constraint. That
will be applied on the field
It will be applied ...

http://codereview.appspot.com/907042/diff/50001/42013#newcode54
doc/ref/models/fields.rst:54: It only works for now on relational fields like
:class:`Many2One`,
For now it only works on relational fields ...

http://codereview.appspot.com/907042/diff/50001/42013#newcode63
doc/ref/models/fields.rst:63: A dictionary that defines dynamic states of the
field and override the static
overrides

http://codereview.appspot.com/907042/diff/50001/42013#newcode80
doc/ref/models/fields.rst:80: IF true, the field can be used as condition for a
custom default value.
can be used as a condition

http://codereview.appspot.com/907042/diff/50001/42013#newcode89
doc/ref/models/fields.rst:89: *Advanced Search* in the search box.
Shouldn't be mentioned there that an index is created for this field in the
database?

http://codereview.appspot.com/907042/diff/50001/42013#newcode96
doc/ref/models/fields.rst:96: A list of field name, if set, the client will call
the method
A list of field names. If this attribute is set the client will call ...

http://codereview.appspot.com/907042/diff/50001/42013#newcode102
doc/ref/models/fields.rst:102: And must return a dictionary with the values of
fields that must be updated.
It must return...

http://codereview.appspot.com/907042/diff/50001/42013#newcode114
doc/ref/models/fields.rst:114: A list of field name, like :attr:`on_change`, but
defined the other way arround.
A list of field names

http://codereview.appspot.com/907042/diff/50001/42013#newcode115
doc/ref/models/fields.rst:115: If set, the client will call the method
``on_change_with_<field name>`` of the
If this attribute is set,

http://codereview.appspot.com/907042/diff/50001/42013#newcode121
doc/ref/models/fields.rst:121: And must return the new value of the field.
It must return...

http://codereview.appspot.com/907042/diff/50001/42013#newcode172
doc/ref/models/fields.rst:172: A integer field.
An integer field.

http://codereview.appspot.com/907042/diff/50001/42013#newcode192
doc/ref/models/fields.rst:192: The maximum length (in characters) of the field.
The size is enforce at the
The size is enforced

http://codereview.appspot.com/907042/diff/50001/42013#newcode197
doc/ref/models/fields.rst:197: If true, the value of the field is translatable.
The value readed and
The values

http://codereview.appspot.com/907042/diff/50001/42013#newcode414
doc/ref/models/fields.rst:414: - ``('unkink', [ids, ...])``: it will unlink the
target ids from this
unlink

http://codereview.appspot.com/907042/diff/50001/42013#newcode429
doc/ref/models/fields.rst:429: The name of the field that handle the opposite
:class:`Many2One`
that handles

http://codereview.appspot.com/907042/diff/50001/42015
File doc/ref/models/models.rst (right):

http://codereview.appspot.com/907042/diff/50001/42015#newcode28
doc/ref/models/models.rst:28: 
unnecessary empty line

http://codereview.appspot.com/907042/diff/50001/42015#newcode55
doc/ref/models/models.rst:55: Register the model in ``ir.model`` and
``ir.model.field``.
Registers

http://codereview.appspot.com/907042/diff/50001/42015#newcode59
doc/ref/models/models.rst:59: Raise an exception that will be displayed as an
error message in the
Raises

http://codereview.appspot.com/907042/diff/50001/42015#newcode68
doc/ref/models/models.rst:68: Raise an exception that will be displayed as a
warning message on the
Raises

http://codereview.appspot.com/907042/diff/50001/42015#newcode97
doc/ref/models/models.rst:97: Return a view definition used by the client. The
definition is::
doubled colon at the end

http://codereview.appspot.com/907042/diff/50001/42015#newcode257
doc/ref/models/models.rst:257: modification of data coming from XML files but
this method must be overiden
..coming from XML files. This method must be overridden...

http://codereview.appspot.com/907042/diff/50001/42015#newcode331
doc/ref/models/models.rst:331: Could be overrided to use a custom SQL query
instead of a table of the
Can be overridden...

http://codereview.appspot.com/907042/diff/50001/42020
File doc/topics/models/index.rst (right):

http://codereview.appspot.com/907042/diff/50001/42020#newcode8
doc/topics/models/index.rst:8: defines the behaviors of the data. Most of the
time, each model stores data in
defines the behavior of the data

http://codereview.appspot.com/907042/diff/50001/42021
File doc/topics/modules/index.rst (right):

http://codereview.appspot.com/907042/diff/50001/42021#newcode157
doc/topics/modules/index.rst:157: * ``search``: Only for relation field, it
contains a domain on which
It contains a domain which is used to search for the value to use. The first
value found will be used.

http://codereview.appspot.com/907042/diff/50001/42021#newcode160
doc/topics/modules/index.rst:160: * ``ref``: Only for relation field, it
contains an xml id of the
Only for relation field. It contains...

[udono, 2010-04-29 14:38:16]

Some more review

http://codereview.appspot.com/907042/diff/50001/42004
File doc/conf.py (right):

http://codereview.appspot.com/907042/diff/50001/42004#newcode125
doc/conf.py:125: html_static_path = ['_static']
_static path is missing. Build warns:

copying static files... WARNING: static directory
'/home/uspallek/workspace/tryton/tip/trytond/doc/_static' does not exist

http://codereview.appspot.com/907042/diff/50001/42005
File doc/index.rst (right):

http://codereview.appspot.com/907042/diff/50001/42005#newcode43
doc/index.rst:43: :ref:`Extension <topics-extension>`
topics-extension doesn't exist. It raises a warning on build:

/home/uspallek/workspace/tryton/tip/trytond/doc/index.rst:42: WARNING: undefined
label: topics-extension

http://codereview.appspot.com/907042/diff/50001/42015
File doc/ref/models/models.rst (right):

http://codereview.appspot.com/907042/diff/50001/42015#newcode267
doc/ref/models/models.rst:267: Trigger a trigger event on the :ref:`workflow
<topics-workflow>` of
target topics-workflow does not exist.

http://codereview.appspot.com/907042/diff/50001/42020
File doc/topics/models/index.rst (right):

http://codereview.appspot.com/907042/diff/50001/42020#newcode16
doc/topics/models/index.rst:16: * :ref:`Fields <topics-fields>` are defined as
model attributes.
target topics-fields does not exist

http://codereview.appspot.com/907042/diff/50001/42020#newcode39
doc/topics/models/index.rst:39: :ref:`Pool <topics-pool>`.  Model instances are
essentially accessors to
target topics-pool does not exist.

[udono, 2010-04-29 14:43:11]

http://codereview.appspot.com/907042/diff/50001/42005
File doc/index.rst (right):

http://codereview.appspot.com/907042/diff/50001/42005#newcode27
doc/index.rst:27: * **Installation**
On 2010/04/28 17:58:59, ced wrote:
> On 2010/04/27 11:40:01, udono wrote:
> > Installation_:_
> 
> ???
Missing double point like in the other sections.

http://codereview.appspot.com/907042/diff/50001/42013
File doc/ref/models/fields.rst (right):

http://codereview.appspot.com/907042/diff/50001/42013#newcode106
doc/ref/models/fields.rst:106: The on_change_<field name> methods are run in a
rollbacked transaction.
On 2010/04/28 17:58:59, ced wrote:
> On 2010/04/27 11:40:01, udono wrote:
> > This means the cursor is not committed when leaving those methods.
> 
> It is the same.

Done.

[udono, 2010-04-29 14:47:32]

http://codereview.appspot.com/907042/diff/50001/42013
File doc/ref/models/fields.rst (right):

http://codereview.appspot.com/907042/diff/50001/42013#newcode172
doc/ref/models/fields.rst:172: A integer field.
On 2010/04/27 11:40:01, udono wrote:
> The client represents this field as a entry box restricted to numbers.

... as an entry ...

for thi and the following occurrences.

http://codereview.appspot.com/907042/diff/50001/42013#newcode205
doc/ref/models/fields.rst:205: A string field for which the value will be stored
with a `secure hash
A string field which value...

[udono, 2010-05-05 11:48:58]

http://codereview.appspot.com/907042/diff/66001/67011
File doc/ref/models/fields.rst (right):

http://codereview.appspot.com/907042/diff/66001/67011#newcode54
doc/ref/models/fields.rst:54: For now It only works on relational fields like
:class:`Many2One`,
it

http://codereview.appspot.com/907042/diff/66001/67011#newcode96
doc/ref/models/fields.rst:96: A list of field name, if this attribute is set,
the client will call the method
names

http://codereview.appspot.com/907042/diff/66001/67011#newcode96
doc/ref/models/fields.rst:96: A list of field name, if this attribute is set,
the client will call the method
What happens to the list field names?

http://codereview.appspot.com/907042/diff/66001/67011#newcode97
doc/ref/models/fields.rst:97: ``on_change_<field name>`` of the model when the
user changes the current field
Not good to talk about a list of field names and on_change_field_name in one
context. This will no one understand imho.

http://codereview.appspot.com/907042/diff/66001/67011#newcode112
doc/ref/models/fields.rst:112: .. attribute:: Field.on_change_with
same as last comment.

http://codereview.appspot.com/907042/diff/66001/67011#newcode415
doc/ref/models/fields.rst:415: - ``('unkink', [ids, ...])``: it will unlink the
target ids from this
unlink

http://codereview.appspot.com/907042/diff/66001/67011#newcode570
doc/ref/models/fields.rst:570: :attr:`~Function.searcher` that use `ir.property`
to store values.
model ir property

http://codereview.appspot.com/907042/diff/70002/76021
File doc/topics/views/extension.rst (right):

http://codereview.appspot.com/907042/diff/70002/76021#newcode18
doc/topics/views/extension.rst:18: XML description
inconsistent menu level. Better use

XML description 
===============

http://codereview.appspot.com/907042/diff/70002/76021#newcode22
doc/topics/views/extension.rst:22: ^^^^
better use 
----

http://codereview.appspot.com/907042/diff/70002/76021#newcode36
doc/topics/views/extension.rst:36: -------
=======

[bch, 2010-05-05 15:32:28]

My biggest concern with the refactoring is that there are no consistency when
navigating the documentation with the "previous" and "next" buttons. I don't
know if it's possible to improve it (this means reorganizing stuffs), but
removing the links is easy via a custom layout (and I'm volunteer for the
patch).

[ced, 2010-05-05 15:56:30]

On 2010/05/05 15:32:28, bch wrote:
> My biggest concern with the refactoring is that there are no consistency when
> navigating the documentation with the "previous" and "next" buttons. I don't
> know if it's possible to improve it (this means reorganizing stuffs), but
> removing the links is easy via a custom layout (and I'm volunteer for the
> patch).

It follow the index order

[udono, 2010-05-05 22:09:17]

Headlines in english are usually with capital letters.

http://codereview.appspot.com/907042/diff/98001/99003
File doc/conf.py (right):

http://codereview.appspot.com/907042/diff/98001/99003#newcode125
doc/conf.py:125: html_static_path = ['_static']
What about this static thing?
copying static files... WARNING: static directory
'/home/uspallek/workspace/tryton/tip/trytond/doc/_static' does not exist

http://codereview.appspot.com/907042/diff/98001/99020
File doc/topics/models/index.rst (right):

http://codereview.appspot.com/907042/diff/98001/99020#newcode18
doc/topics/models/index.rst:18: * Tryton generates the tables definition and
provides an API to access the
table definitions

http://codereview.appspot.com/907042/diff/98001/99020#newcode21
doc/topics/models/index.rst:21: Quick example
Example

http://codereview.appspot.com/907042/diff/98001/99020#newcode43
doc/topics/models/index.rst:43: Model attributes define meta-information of the
model, they are class
Model attributes define meta-information of the model. They are...

http://codereview.appspot.com/907042/diff/98001/99020#newcode44
doc/topics/models/index.rst:44: attributes starting with an underscore.  Some
Model Properties are instance
model properties

http://codereview.appspot.com/907042/diff/98001/99021
File doc/topics/modules/index.rst (right):

http://codereview.appspot.com/907042/diff/98001/99021#newcode7
doc/topics/modules/index.rst:7: The modules of Tryton extend the functionality
of the platform. The server
extends

http://codereview.appspot.com/907042/diff/98001/99021#newcode8
doc/topics/modules/index.rst:8: comes by default with only a basic functionality
included in those modules:
these modules ?

http://codereview.appspot.com/907042/diff/98001/99021#newcode14
doc/topics/modules/index.rst:14: A module is a directory in trytond/modules that
contains at least two files:
which contain?

http://codereview.appspot.com/907042/diff/98001/99021#newcode24
doc/topics/modules/index.rst:24: python files from the module.
Python

http://codereview.appspot.com/907042/diff/98001/99021#newcode48
doc/topics/modules/index.rst:48: * ``depends``: A list of modules on which the
module depends.
*this* module depends

http://codereview.appspot.com/907042/diff/98001/99021#newcode89
doc/topics/modules/index.rst:89: Python files
Files

http://codereview.appspot.com/907042/diff/98001/99021#newcode92
doc/topics/modules/index.rst:92: The Python files define the Models for the
modules.
models

http://codereview.appspot.com/907042/diff/98001/99021#newcode94
doc/topics/modules/index.rst:94: XML files
Files

http://codereview.appspot.com/907042/diff/98001/99024
File doc/topics/views/extension.rst (right):

http://codereview.appspot.com/907042/diff/98001/99024#newcode4
doc/topics/views/extension.rst:4: Extend view
View

http://codereview.appspot.com/907042/diff/98001/99024#newcode8
doc/topics/views/extension.rst:8: that are defined with XML.
that are: which are ... in XML

http://codereview.appspot.com/907042/diff/98001/99024#newcode18
doc/topics/views/extension.rst:18: XML description
Description

[udono, 2010-05-06 09:38:38]

http://codereview.appspot.com/907042/diff/105001/106012
File doc/ref/models/fields.rst (right):

http://codereview.appspot.com/907042/diff/105001/106012#newcode8
doc/ref/models/fields.rst:8: Fields define the behaviors of the data on model's
record.
This sentence says nothing.

http://codereview.appspot.com/907042/diff/105001/106012#newcode107
doc/ref/models/fields.rst:107: The on_change_<field name> methods are run in a
rollbacked transaction.
running

http://codereview.appspot.com/907042/diff/105001/106012#newcode116
doc/ref/models/fields.rst:116: arround.  If this attribute is set, the client
will call the method
around

http://codereview.appspot.com/907042/diff/105001/106012#newcode118
doc/ref/models/fields.rst:118: field defined in the list and will give the
values of each fields in this list.
fields

http://codereview.appspot.com/907042/diff/105001/106012#newcode127
doc/ref/models/fields.rst:127: The on_change_with_<field name> methods are run
in a rollbacked transaction.
running

http://codereview.appspot.com/907042/diff/105001/106012#newcode136
doc/ref/models/fields.rst:136: A list of field names on which this one depends.
This means that the client
the current one depends

http://codereview.appspot.com/907042/diff/105001/106012#newcode439
doc/ref/models/fields.rst:439: client will allow to add/remove records instead
of only create/delete.
add/remove existing records

http://codereview.appspot.com/907042/diff/105001/106012#newcode518
doc/ref/models/fields.rst:518: where `names` is a list of name fields, and it
must return a dictionary
Where ... fields. It must

http://codereview.appspot.com/907042/diff/105001/106012#newcode520
doc/ref/models/fields.rst:520: 
This sentence is not good to understand. Maybe an example helps?

http://codereview.appspot.com/907042/diff/105001/106012#newcode526
doc/ref/models/fields.rst:526: value.
the value

http://codereview.appspot.com/907042/diff/105001/106012#newcode541
doc/ref/models/fields.rst:541: where `name` is the name of the field and
`clause` is a clause of
clause of domain => domain clause

http://codereview.appspot.com/907042/diff/105001/106012#newcode543
doc/ref/models/fields.rst:543: It must return a list of :ref:`domain
<topics-domain>` clause.
clauses

http://codereview.appspot.com/907042/diff/105001/106014
File doc/ref/models/models.rst (right):

http://codereview.appspot.com/907042/diff/105001/106014#newcode22
doc/ref/models/models.rst:22: .. todo::
It contains a dictionary with one or more :attr:`Model._name` as keys. For each
key a :class:`trytond.model.fields.Many2One` field is defined as value. The
:class:`trytond.model.fields.Many2One` fields must be defined in the the current
model fields. A referenced model with ``_inherits`` is a generalization_ of the
current model which is *specialized*. In the specialized model it is possible to
interact with all attributes and methods of the general model.

.. _generalization:: http://en.wikipedia.org/wiki/Class_diagram#Generalization

http://codereview.appspot.com/907042/diff/105001/106019
File doc/topics/install.rst (right):

http://codereview.appspot.com/907042/diff/105001/106019#newcode26
doc/topics/install.rst:26: You've got three easy options to install Tryton:
We did not use 'you' in other parts of the documentation?!

[udono, 2010-05-07 12:48:30]

http://codereview.appspot.com/907042/diff/107002/95037
File doc/conf.py (right):

http://codereview.appspot.com/907042/diff/107002/95037#newcode43
doc/conf.py:43: copyright = u'2008-2010, Bertrand Chenal, Cédric Krier, Udo
Spallek'
Ian Wilson wrote afaik the report section.

http://codereview.appspot.com/907042/diff/107002/95037#newcode178
doc/conf.py:178: u'Bertrand Chenal, Cédric Krier, Udo Spallek', 'manual'),
Ian Wilson?

http://codereview.appspot.com/907042/diff/107002/95046
File doc/ref/models/fields.rst (right):

http://codereview.appspot.com/907042/diff/107002/95046#newcode8
doc/ref/models/fields.rst:8: Fields define the behaviors of the data on model's
record.
behavior

http://codereview.appspot.com/907042/diff/107002/95046#newcode52
doc/ref/models/fields.rst:52: .. warning::
.. note:: ?

http://codereview.appspot.com/907042/diff/107002/95046#newcode66
doc/ref/models/fields.rst:66: with the record values.
with the values of the record.

http://codereview.appspot.com/907042/diff/107002/95046#newcode73
doc/ref/models/fields.rst:73: Give the order in which setter methods (if exist)
are called on a model.
An integer, which give...
Default is 0. Lower priority called first.

http://codereview.appspot.com/907042/diff/107002/95046#newcode96
doc/ref/models/fields.rst:96: A list of field names, if this attribute is set,
the client will call the
... names. If ...

http://codereview.appspot.com/907042/diff/107002/95046#newcode103
doc/ref/models/fields.rst:103: It must return a dictionary with the values of
fields that must be updated.
    This method need to return a dictionary with the values of fields to be
updated.

http://codereview.appspot.com/907042/diff/107002/95046#newcode115
doc/ref/models/fields.rst:115: A list of field names, like :attr:`on_change`,
but defined the other way
... names. Same like...

http://codereview.appspot.com/907042/diff/107002/95046#newcode123
doc/ref/models/fields.rst:123: It must return the new value of the field.
    This method need to return the new value of the field.

http://codereview.appspot.com/907042/diff/107002/95046#newcode137
doc/ref/models/fields.rst:137: client will also read those fields even if they
are not defined on the view.
those->these?

http://codereview.appspot.com/907042/diff/107002/95046#newcode146
doc/ref/models/fields.rst:146: The name of a substitute field on which the
ordering of record must be done
ordering of records

http://codereview.appspot.com/907042/diff/107002/95046#newcode193
doc/ref/models/fields.rst:193: The maximum length (in characters) of the field.
The size is enforced at
An integer, which defines the maximum count of characters of the field. The
``size``...

http://codereview.appspot.com/907042/diff/107002/95046#newcode239
doc/ref/models/fields.rst:239: A tuple of two integers defining the total of
numbers in integer part and
A tuple of two integers. The first integer defines the total count of digits.
The second integer defines the count of places after the decimal point.

http://codereview.appspot.com/907042/diff/107002/95046#newcode290
doc/ref/models/fields.rst:290: A string field with limited choice values.
choice values-> values to choice

http://codereview.appspot.com/907042/diff/107002/95046#newcode306
doc/ref/models/fields.rst:306: It can also be the name of a method on the model,
that will return the
...return an appropriate list.

http://codereview.appspot.com/907042/diff/107002/95046#newcode325
doc/ref/models/fields.rst:325: It true, the human-readable values will be
translated. Default value is
It->If

http://codereview.appspot.com/907042/diff/107002/95046#newcode355
doc/ref/models/fields.rst:355: The name of the targeted model.
target model

http://codereview.appspot.com/907042/diff/107002/95046#newcode373
doc/ref/models/fields.rst:373: Define the behavior of the record when the target
record is deleted.
current record

http://codereview.appspot.com/907042/diff/107002/95046#newcode380
doc/ref/models/fields.rst:380: - ``SET NULL``: it will empty the relation field.
``SET NULL`` is the default setting.

http://codereview.appspot.com/907042/diff/107002/95046#newcode428
doc/ref/models/fields.rst:428: The name of the targeted model.
target

http://codereview.appspot.com/907042/diff/107002/95046#newcode476
doc/ref/models/fields.rst:476: :attr:`~Many2Many.origin` and
:attr:`~Many2Many.target` are set to `None`.
Sentence complicated. Maybe:

A :class:`Many2Many` field can be used on a simple
:class:`~trytond.model.ModelView`, like in a:class:`~trytond.wizard.Wizard`. For
this,
:attr:`~Many2Many.relation_name` is set to the target model and
:attr:`~Many2Many.origin` and :attr:`~Many2Many.target` are set to `None`.

http://codereview.appspot.com/907042/diff/107002/95046#newcode500
doc/ref/models/fields.rst:500: A function field that can emulate any other given
`field`.
...field can emulate...

http://codereview.appspot.com/907042/diff/107002/95048
File doc/ref/models/models.rst (right):

http://codereview.appspot.com/907042/diff/107002/95048#newcode209
doc/ref/models/models.rst:209: values for those fields otherwise it will be for
all fields.
those->these?

http://codereview.appspot.com/907042/diff/107002/95048#newcode210
doc/ref/models/models.rst:210: If ids is a list of ids, the returned value will
be a list of dictionary.
If ``ids`` .... dictionaries.

http://codereview.appspot.com/907042/diff/107002/95048#newcode211
doc/ref/models/models.rst:211: If ids is an integer, the returned value will be
a dictionary.
If ``ids`` is...

http://codereview.appspot.com/907042/diff/107002/95048#newcode290
doc/ref/models/models.rst:290: It implement :class:`ModelStorage` for an SQL
database.
for a SQL

http://codereview.appspot.com/907042/diff/107002/95048#newcode297
doc/ref/models/models.rst:297: If not set the value of :attr:`Model._name` is
used
not set, the

http://codereview.appspot.com/907042/diff/107002/95048#newcode318
doc/ref/models/models.rst:318: If `True`, all changes on records will be stored
in an history table.
a history table

http://codereview.appspot.com/907042/diff/107002/95052
File doc/topics/index.rst (right):

http://codereview.appspot.com/907042/diff/107002/95052#newcode4
doc/topics/index.rst:4: =============
=============
Using trytond
=============

http://codereview.appspot.com/907042/diff/107002/95053
File doc/topics/install.rst (right):

http://codereview.appspot.com/907042/diff/107002/95053#newcode8
doc/topics/install.rst:8: -------------
==============

http://codereview.appspot.com/907042/diff/107002/95053#newcode24
doc/topics/install.rst:24: --------------
=================

http://codereview.appspot.com/907042/diff/107002/95055
File doc/topics/modules/index.rst (right):

http://codereview.appspot.com/907042/diff/107002/95055#newcode12
doc/topics/modules/index.rst:12: ****************
===============

http://codereview.appspot.com/907042/diff/107002/95055#newcode21
doc/topics/modules/index.rst:21: ^^^^^^^^^^^^^^^^^^^^
------------------

http://codereview.appspot.com/907042/diff/107002/95055#newcode28
doc/topics/modules/index.rst:28: ^^^^^^^^^^^^^^^^^^^^^^
-------------------

http://codereview.appspot.com/907042/diff/107002/95055#newcode48
doc/topics/modules/index.rst:48: * ``depends``: A list of modules on which this
module depends.
of module names

http://codereview.appspot.com/907042/diff/107002/95055#newcode90
doc/topics/modules/index.rst:90: ************
================

http://codereview.appspot.com/907042/diff/107002/95055#newcode95
doc/topics/modules/index.rst:95: *********
============

http://codereview.appspot.com/907042/diff/107002/95057
File doc/topics/reports/index.rst (right):

http://codereview.appspot.com/907042/diff/107002/95057#newcode17
doc/topics/reports/index.rst:17: ****************
===========

http://codereview.appspot.com/907042/diff/107002/95057#newcode42
doc/topics/reports/index.rst:42: *************
=============

http://codereview.appspot.com/907042/diff/107002/95057#newcode49
doc/topics/reports/index.rst:49: **********
=============

http://codereview.appspot.com/907042/diff/107002/95057#newcode52
doc/topics/reports/index.rst:52: ==========
----------

http://codereview.appspot.com/907042/diff/107002/95057#newcode57
doc/topics/reports/index.rst:57: ===============
-------------

http://codereview.appspot.com/907042/diff/107002/95057#newcode79
doc/topics/reports/index.rst:79: ************
=============

http://codereview.appspot.com/907042/diff/107002/95057#newcode82
doc/topics/reports/index.rst:82: ====================================
-------------

http://codereview.appspot.com/907042/diff/107002/95057#newcode85
doc/topics/reports/index.rst:85: ----------------------
....................

http://codereview.appspot.com/907042/diff/107002/95057#newcode128
doc/topics/reports/index.rst:128: ---------------------------
........................

http://codereview.appspot.com/907042/diff/107002/95057#newcode142
doc/topics/reports/index.rst:142: --------
.........

http://codereview.appspot.com/907042/diff/107002/95057#newcode156
doc/topics/reports/index.rst:156: =======================================
----------------------

http://codereview.appspot.com/907042/diff/107002/95057#newcode174
doc/topics/reports/index.rst:174:
=========================================================
-------------------------

http://codereview.appspot.com/907042/diff/107002/95057#newcode179
doc/topics/reports/index.rst:179:
====================================================
-----------------------

http://codereview.appspot.com/907042/diff/107002/95057#newcode187
doc/topics/reports/index.rst:187: =================================
----------------------

http://codereview.appspot.com/907042/diff/107002/95057#newcode217
doc/topics/reports/index.rst:217: ===============================
------------------------

http://codereview.appspot.com/907042/diff/107002/95057#newcode244
doc/topics/reports/index.rst:244: ================================
----------------------

http://codereview.appspot.com/907042/diff/107002/95058
File doc/topics/views/extension.rst (right):

http://codereview.appspot.com/907042/diff/107002/95058#newcode4
doc/topics/views/extension.rst:4: Extend View
Extending Views

http://codereview.appspot.com/907042/diff/107002/95058#newcode7
doc/topics/views/extension.rst:7: Extend a view means, that the original view
will be modified by a set of rules
Extending a ...

http://codereview.appspot.com/907042/diff/107002/95059
File doc/topics/views/index.rst (right):

http://codereview.appspot.com/907042/diff/107002/95059#newcode9
doc/topics/views/index.rst:9: In Tryton objects can have several views. It is
the action, that opens the
Objects can have several views in Tryton.

http://codereview.appspot.com/907042/diff/107002/95059#newcode9
doc/topics/views/index.rst:9: In Tryton objects can have several views. It is
the action, that opens the
An `action` opens a window and defines which view to show.

http://codereview.appspot.com/907042/diff/107002/95059#newcode12
doc/topics/views/index.rst:12: The views are built from XML that is stored in
the databases with the object
build

http://codereview.appspot.com/907042/diff/107002/95059#newcode73
doc/topics/views/index.rst:73: * ``xexpand``: The same as expand but for
vertical space.
Is this right? The X-axis is usually horizontal

http://codereview.appspot.com/907042/diff/107002/95059#newcode77
doc/topics/views/index.rst:77: * ``colspan``: The number of columns the label
must take in the table.
label=widget

http://codereview.appspot.com/907042/diff/107002/95059#newcode79
doc/topics/views/index.rst:79: * ``states``: A string of python code that will
be evaluated with the field
Python

http://codereview.appspot.com/907042/diff/107002/95059#newcode98
doc/topics/views/index.rst:98: ^^^^
Why using ^^^^^^ ? Better is using a more light markup then the level before,
which could be ----------. So I propose something like ....... to use. 
But the best imho is not use more than three heading levels.

http://codereview.appspot.com/907042/diff/107002/95059#newcode115
doc/topics/views/index.rst:115: ^^^^^
.........

http://codereview.appspot.com/907042/diff/107002/95059#newcode130
doc/topics/views/index.rst:130: ^^^^^
..............

http://codereview.appspot.com/907042/diff/107002/95059#newcode167
doc/topics/views/index.rst:167: ^^^^^
...........

http://codereview.appspot.com/907042/diff/107002/95059#newcode175
doc/topics/views/index.rst:175: ^^^^^^^^^
............

http://codereview.appspot.com/907042/diff/107002/95059#newcode185
doc/topics/views/index.rst:185: ^^^^^^^
.............

http://codereview.appspot.com/907042/diff/107002/95059#newcode190
doc/topics/views/index.rst:190: ^^^^^^
...........

http://codereview.appspot.com/907042/diff/107002/95059#newcode215
doc/topics/views/index.rst:215: ^^^^^^^^
..............

http://codereview.appspot.com/907042/diff/107002/95059#newcode222
doc/topics/views/index.rst:222: ^^^^
.....

http://codereview.appspot.com/907042/diff/107002/95059#newcode234
doc/topics/views/index.rst:234: ^^^^^
...........

http://codereview.appspot.com/907042/diff/107002/95059#newcode251
doc/topics/views/index.rst:251: child1,child2
child1, child2