Skip to content

Commit

Permalink
[IMP] doc: grammar and readability
Browse files Browse the repository at this point in the history
Backport of most of odoo#6827 by J Bradshaw with additional
modifications (and some reverts) during review.

closes odoo#6827
  • Loading branch information
jbradsha authored and xmo-odoo committed Jul 7, 2015
1 parent 95e56a1 commit 2f7ab00
Show file tree
Hide file tree
Showing 13 changed files with 158 additions and 219 deletions.
77 changes: 0 additions & 77 deletions doc/README.rst

This file was deleted.

33 changes: 16 additions & 17 deletions doc/api_integration.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,8 @@
Web Service API
===============

Odoo is mostly extended internally via modules, but much of its features and
all of its data is also available from the outside for external analysis or
Odoo is usually extended internally via modules, but many of its features and
all of its data are also available from the outside for external analysis or
integration with various tools. Part of the :ref:`reference/orm/model` API is
easily available over XML-RPC_ and accessible from a variety of languages.

Expand Down Expand Up @@ -196,8 +196,8 @@ database:
Logging in
----------
Odoo requires users of the API to be authenticated before being able to query
much data.
Odoo requires users of the API to be authenticated before they can query most
data.
The ``xmlrpc/2/common`` endpoint provides meta-calls which don't require
authentication, such as the authentication itself or fetching version
Expand Down Expand Up @@ -384,7 +384,7 @@ companies for instance:
Pagination
''''''''''
By default a research will return the ids of all records matching the
By default a search will return the ids of all records matching the
condition, which may be a huge number. ``offset`` and ``limit`` parameters are
available to only retrieve a subset of all matched records.
Expand Down Expand Up @@ -432,8 +432,8 @@ available to only retrieve a subset of all matched records.
Count records
-------------
Rather than retrieve a possibly gigantic list of records and count them
afterwards, :meth:`~openerp.models.Model.search_count` can be used to retrieve
Rather than retrieve a possibly gigantic list of records and count them,
:meth:`~openerp.models.Model.search_count` can be used to retrieve
only the number of records matching the query. It takes the same
:ref:`domain <reference/orm/domains>` filter as
:meth:`~openerp.models.Model.search` and no other parameter.
Expand Down Expand Up @@ -600,8 +600,7 @@ Listing record fields
:meth:`~openerp.models.Model.fields_get` can be used to inspect
a model's fields and check which ones seem to be of interest.
Because
it returns a great amount of meta-information (it is also used by client
Because it returns a large amount of meta-information (it is also used by client
programs) it should be filtered before printing, the most interesting items
for a human user are ``string`` (the field's label), ``help`` (a help text if
available) and ``type`` (to know which values to expect, or to send when
Expand Down Expand Up @@ -682,15 +681,15 @@ updating a record):
Search and read
---------------
Because that is a very common task, Odoo provides a
Because it is a very common task, Odoo provides a
:meth:`~openerp.models.Model.search_read` shortcut which as its name notes is
equivalent to a :meth:`~openerp.models.Model.search` followed by a
:meth:`~openerp.models.Model.read`, but avoids having to perform two requests
and keep ids around.
Its arguments are similar to :meth:`~openerp.models.Model.search`'s, but it
can also take a list of ``fields`` (like :meth:`~openerp.models.Model.read`,
if that list is not provided it'll fetch all fields of matched records):
if that list is not provided it will fetch all fields of matched records):
.. container:: doc-aside
Expand Down Expand Up @@ -888,8 +887,8 @@ a record).
Delete records
--------------
Records can be deleted in bulk by providing the ids of all records to remove
to :meth:`~openerp.models.Model.unlink`.
Records can be deleted in bulk by providing their ids to
:meth:`~openerp.models.Model.unlink`.
.. container:: doc-aside
Expand Down Expand Up @@ -945,7 +944,7 @@ Inspection and introspection
isn't exactly fun in RPC.
While we previously used :meth:`~openerp.models.Model.fields_get` to query a
model's and have been using an arbitrary model from the start, Odoo stores
model and have been using an arbitrary model from the start, Odoo stores
most model metadata inside a few meta-models which allow both querying the
system and altering models and fields (with some limitations) on the fly over
XML-RPC.
Expand All @@ -955,7 +954,7 @@ XML-RPC.
``ir.model``
''''''''''''
Provides informations about Odoo models themselves via its various fields
Provides information about Odoo models via its various fields
``name``
a human-readable description of the model
Expand Down Expand Up @@ -1100,7 +1099,7 @@ Provides informations about Odoo models themselves via its various fields
``ir.model.fields``
'''''''''''''''''''
Provides informations about the fields of Odoo models and allows adding
Provides information about the fields of Odoo models and allows adding
custom fields without using Python code
``model_id``
Expand Down Expand Up @@ -1285,7 +1284,7 @@ the workflow instance associated with the record.
.. container:: doc-aside
.. warning:: requires that the ``account`` module be installed
.. warning:: this example needs ``account`` module installed
.. switcher::
Expand Down
11 changes: 11 additions & 0 deletions doc/cla/individual/jbradsha.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
United Kingdom, 2015-05-22

I hereby agree to the terms of the Odoo Individual Contributor License
Agreement v1.0.

I declare that I am authorized and able to make this agreement and sign this
declaration.

Signed,

John Bradshaw - [email protected] - https://github.com/jbradsha
Loading

0 comments on commit 2f7ab00

Please sign in to comment.