From 82b08318fe0bd3d4cb92ee3a46873714e51a708a Mon Sep 17 00:00:00 2001 From: Daniel Watkins Date: Thu, 14 Apr 2011 22:20:45 +0100 Subject: Typo fixes. bzr revid: daniel@daniel-watkins.co.uk-20110414212045-hlglpa7dfum3j15w --- doc/source/development.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) (limited to 'doc/source/development.rst') diff --git a/doc/source/development.rst b/doc/source/development.rst index a1d989b46ac..81f2d8219a5 100644 --- a/doc/source/development.rst +++ b/doc/source/development.rst @@ -55,7 +55,7 @@ Events Event triggered after a user asked for a search. The search view fires this event after collecting all input data (contexts, domains and group_by contexts). Note that the search view does *not* merge - those (or therwise evaluate them), they are returned as provided by + those (or otherwise evaluate them), they are returned as provided by the various inputs within the view. ``on_clear`` @@ -104,7 +104,7 @@ reaction: the search process. :js:class:`~openerp.base.search.Invalid` takes three mandatory - arguments: an indentifier (a name for instance), the invalid value + arguments: an identifier (a name for instance), the invalid value, and a validation message indicating the issue. ``get_domain`` -- cgit v1.2.3 From 8b4fd867430b8e14c8d48b8d6c8ee2c9d41df121 Mon Sep 17 00:00:00 2001 From: Daniel Watkins Date: Thu, 14 Apr 2011 22:21:32 +0100 Subject: s/have to/must/ -- it's a more common directive in docs. bzr revid: daniel@daniel-watkins.co.uk-20110414212132-yw281minl1zx5a7d --- doc/source/development.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'doc/source/development.rst') diff --git a/doc/source/development.rst b/doc/source/development.rst index 81f2d8219a5..8e37ed744b1 100644 --- a/doc/source/development.rst +++ b/doc/source/development.rst @@ -114,7 +114,7 @@ reaction: The :js:class:`openerp.base.search.Input` type implements registration on its own, but its implementations of ``get_context`` and -``get_domain`` simply raise errors and *have* to be overridden. +``get_domain`` simply raise errors and *must* be overridden. One last action is for filters, as an activation order has to be kept on them for some controls (establish the correct grouping sequence for -- cgit v1.2.3 From 417bdbf6903d440333e6e221740d2a9140569bff Mon Sep 17 00:00:00 2001 From: Daniel Watkins Date: Thu, 14 Apr 2011 22:23:43 +0100 Subject: s/falsy// bzr revid: daniel@daniel-watkins.co.uk-20110414212343-aam4fc6nxgkxmnwz --- doc/source/development.rst | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) (limited to 'doc/source/development.rst') diff --git a/doc/source/development.rst b/doc/source/development.rst index 8e37ed744b1..a103893d86c 100644 --- a/doc/source/development.rst +++ b/doc/source/development.rst @@ -71,7 +71,7 @@ An important concept in the search view is that of input. It is both an informal protocol and an abstract type that can be inherited from. Inputs are widgets which can contain user data (a char widget for -instance, or a selection box). They are able of action and of +instance, or a selection box). They are capable of action and of reaction: .. _views-search-registration: @@ -93,9 +93,9 @@ reaction: * Return a context (an object), this is the "normal" response if the input holds a value. - * Return a falsy value (generally ``null``). This value indicates - the input does not contain any value and will not take part in the - research. + * Return a value that evaluates as false (generally ``null``). This + value indicates the input does not contain any value and will not + take part in the research. * Raise :js:class:`openerp.base.search.Invalid` to indicate that it holds a value but this value can not be used in the search -- cgit v1.2.3 From 2fabcdffd988918d1968896f8fe78bc286cb940c Mon Sep 17 00:00:00 2001 From: Daniel Watkins Date: Thu, 14 Apr 2011 22:24:48 +0100 Subject: 'research' unclear; changed wording. bzr revid: daniel@daniel-watkins.co.uk-20110414212448-oncc720ar4gw7td9 --- doc/source/development.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'doc/source/development.rst') diff --git a/doc/source/development.rst b/doc/source/development.rst index a103893d86c..c81ceec9498 100644 --- a/doc/source/development.rst +++ b/doc/source/development.rst @@ -95,7 +95,7 @@ reaction: * Return a value that evaluates as false (generally ``null``). This value indicates the input does not contain any value and will not - take part in the research. + affect the results of the search. * Raise :js:class:`openerp.base.search.Invalid` to indicate that it holds a value but this value can not be used in the search -- cgit v1.2.3 From 8ed08b8d6fed3beccc7e7ef77acefe5268f4de13 Mon Sep 17 00:00:00 2001 From: Daniel Watkins Date: Thu, 14 Apr 2011 22:26:03 +0100 Subject: Minor grammatical improvement. bzr revid: daniel@daniel-watkins.co.uk-20110414212603-3wn8ek3xiawug8ry --- doc/source/development.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) (limited to 'doc/source/development.rst') diff --git a/doc/source/development.rst b/doc/source/development.rst index c81ceec9498..719c6baa74a 100644 --- a/doc/source/development.rst +++ b/doc/source/development.rst @@ -117,8 +117,8 @@ on its own, but its implementations of ``get_context`` and ``get_domain`` simply raise errors and *must* be overridden. One last action is for filters, as an activation order has to be kept -on them for some controls (establish the correct grouping sequence for -instance). +on them for some controls (to establish the correct grouping sequence, +for instance). To that end, filters can call :js:func:`openerp.base.Search.do_toggle_filter`, providing themselves -- cgit v1.2.3 From fcfa8feb192a0979bc515483f645fe04bef7102d Mon Sep 17 00:00:00 2001 From: Daniel Watkins Date: Thu, 14 Apr 2011 22:36:11 +0100 Subject: Consistent reference to methods. bzr revid: daniel@daniel-watkins.co.uk-20110414213611-e7duvzsd65ygxp9o --- doc/source/development.rst | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) (limited to 'doc/source/development.rst') diff --git a/doc/source/development.rst b/doc/source/development.rst index 719c6baa74a..07ee7dabf64 100644 --- a/doc/source/development.rst +++ b/doc/source/development.rst @@ -137,7 +137,7 @@ Life cycle The search view has a pretty simple and linear life cycle, in three main steps: -:js:class:`init ` +:js:class:`~openerp.base.SearchView.init` Nothing interesting happens here @@ -232,7 +232,8 @@ abstract types, used to implement input widgets: `. If inherited from, descendant classes should not call its - implementations of ``get_context`` and ``get_domain``. + implementations of :js:func:`~openerp.base.search.Input.get_context` + and :js:func:`~openerp.base.search.Input.get_domain`. * :js:class:`openerp.base.search.Field` is used to implement more "field" widgets (which allow the user to input potentially complex -- cgit v1.2.3 From ec98904f9c8aec9d32a3cdc21368cdc49836a336 Mon Sep 17 00:00:00 2001 From: Daniel Watkins Date: Thu, 14 Apr 2011 22:36:22 +0100 Subject: Typos. bzr revid: daniel@daniel-watkins.co.uk-20110414213622-7c3zb9zd5o1ur4yb --- doc/source/development.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) (limited to 'doc/source/development.rst') diff --git a/doc/source/development.rst b/doc/source/development.rst index 07ee7dabf64..514e094b689 100644 --- a/doc/source/development.rst +++ b/doc/source/development.rst @@ -211,7 +211,7 @@ called in this order: Gives the widget the opportunity to unbind its events, remove itself from the DOM and perform any other cleanup task it may have. - Event if the widget does not do anything itself, it is responsible + Even if the widget does not do anything itself, it is responsible for shutting down its children. An abstract type is available and can be inherited from, to simplify @@ -252,7 +252,7 @@ abstract types, used to implement input widgets: :js:func:`~openerp.base.search.Widget.make_id`. * It sets up a basic (overridable) - :js:attr:`~opererp.base.search.Field.template` attribute, combined + :js:attr:`~openerp.base.search.Field.template` attribute, combined with the previous tasks, this makes subclasses of :js:class:`~openerp.base.search.Field` render themselves "for free". -- cgit v1.2.3