[docstrings] fix project-wide English language mistake
authorDimitri Papadopoulos <dimitri.papadopoulos@cea.fr>
Tue, 22 Apr 2014 16:39:19 +0200
changeset 10222 75d6096216d7
parent 10221 17ad882a211f
child 10230 b02fbb68ee7a
[docstrings] fix project-wide English language mistake Even though 'u' is a wovel, it may be pronounced 'yu' which is a consonant sound. In such cases precede it with 'a' instead of 'an'.
doc/book/en/devrepo/datamodel/definition.rst
doc/book/en/devrepo/entityclasses/data-as-objects.rst
doc/book/en/devweb/edition/dissection.rst
doc/book/en/devweb/request.rst
doc/book/en/devweb/views/basetemplates.rst
doc/book/en/devweb/views/reledit.rst
doc/book/en/tutorials/base/customizing-the-application.rst
web/formwidgets.py
web/views/basecontrollers.py
web/views/urlpublishing.py
--- a/doc/book/en/devrepo/datamodel/definition.rst	Wed Mar 26 12:30:52 2014 +0100
+++ b/doc/book/en/devrepo/datamodel/definition.rst	Tue Apr 22 16:39:19 2014 +0200
@@ -163,7 +163,7 @@
 
 Common properties for attributes and relations:
 
-* `description`: an unicode string describing an attribute or a
+* `description`: a unicode string describing an attribute or a
   relation. By default this string will be used in the editing form of
   the entity, which means that it is supposed to help the end-user and
   should be flagged by the function `_` to be properly
--- a/doc/book/en/devrepo/entityclasses/data-as-objects.rst	Wed Mar 26 12:30:52 2014 +0100
+++ b/doc/book/en/devrepo/entityclasses/data-as-objects.rst	Tue Apr 22 16:39:19 2014 +0200
@@ -17,7 +17,7 @@
 `Formatting and output generation`:
 
 * :meth:`view(__vid, __registry='views', **kwargs)`, applies the given view to the entity
-  (and returns an unicode string)
+  (and returns a unicode string)
 
 * :meth:`absolute_url(*args, **kwargs)`, returns an absolute URL including the base-url
 
--- a/doc/book/en/devweb/edition/dissection.rst	Wed Mar 26 12:30:52 2014 +0100
+++ b/doc/book/en/devweb/edition/dissection.rst	Tue Apr 22 16:39:19 2014 +0200
@@ -320,7 +320,7 @@
 
   * on success:
 
-    * an url (string) representing the next thing to jump to
+    * a url (string) representing the next thing to jump to
 
 Given the array structure described above, it is quite simple to
 manipulate the DOM to show the errors at appropriate places.
--- a/doc/book/en/devweb/request.rst	Wed Mar 26 12:30:52 2014 +0100
+++ b/doc/book/en/devweb/request.rst	Tue Apr 22 16:39:19 2014 +0200
@@ -89,7 +89,7 @@
     html headers
   * `add_js(jsfiles)`: adds the given list of javascript resources to the
     current html headers
-  * `add_onload(jscode)`: inject the given jscode fragment (an unicode
+  * `add_onload(jscode)`: inject the given jscode fragment (a unicode
     string) into the current html headers, wrapped inside a
     document.ready(...) or another ajax-friendly one-time trigger event
   * `add_header(header, values)`: adds the header/value pair to the
--- a/doc/book/en/devweb/views/basetemplates.rst	Wed Mar 26 12:30:52 2014 +0100
+++ b/doc/book/en/devweb/views/basetemplates.rst	Tue Apr 22 16:39:19 2014 +0200
@@ -116,7 +116,7 @@
 
 * `binary`: boolean flag telling if the view generates some text or a binary
   stream.  Default to False. When view generates text argument given to `self.w`
-  **must be an unicode string**, encoded string otherwise.
+  **must be a unicode string**, encoded string otherwise.
 
 * `content_type`, view's content type, default to 'text/xhtml'
 
@@ -132,7 +132,7 @@
 
 
 You can also modify certain aspects of the main template of a page
-when building an url or setting these parameters in the req.form:
+when building a url or setting these parameters in the req.form:
 
 * `__notemplate`, if present (whatever the value assigned), only the content view
   is returned
--- a/doc/book/en/devweb/views/reledit.rst	Wed Mar 26 12:30:52 2014 +0100
+++ b/doc/book/en/devweb/views/reledit.rst	Tue Apr 22 16:39:19 2014 +0200
@@ -105,9 +105,9 @@
 ensure edition of the `Person` entity instead (using a standard
 automatic form) of the association of Company and Person.
 
-Finally, the `reload` key accepts either a boolean, an eid or an
-unicode string representing an url. If an eid is provided, it will be
-internally transformed into an url. The eid/url case helps when one
+Finally, the `reload` key accepts either a boolean, an eid or a
+unicode string representing a url. If an eid is provided, it will be
+internally transformed into a url. The eid/url case helps when one
 needs to reload and the current url is inappropriate. A common case is
 edition of a key attribute, which is part of the current url. If one
 user changed the Company's name from `lozilab` to `logilab`, reloading
--- a/doc/book/en/tutorials/base/customizing-the-application.rst	Wed Mar 26 12:30:52 2014 +0100
+++ b/doc/book/en/tutorials/base/customizing-the-application.rst	Tue Apr 22 16:39:19 2014 +0200
@@ -268,7 +268,7 @@
   but this is not mandatory.
 
 * When we want to write something to the output stream, we simply call `self.w`,
-  with *must be passed an unicode string*.
+  which *must be passed a unicode string*.
 
 * The latest function is the most exotic stuff. The point is that without it, you
   would get an error at display time because the framework wouldn't be able to
--- a/web/formwidgets.py	Wed Mar 26 12:30:52 2014 +0100
+++ b/web/formwidgets.py	Tue Apr 22 16:39:19 2014 +0200
@@ -709,7 +709,7 @@
 
 
 class JQueryTimePicker(JQueryDatePicker):
-    """Use jquery.timePicker to define a time picker. Will return the time as an
+    """Use jquery.timePicker to define a time picker. Will return the time as a
     unicode string.
     """
     needs_js = ('jquery.timePicker.js',)
--- a/web/views/basecontrollers.py	Wed Mar 26 12:30:52 2014 +0100
+++ b/web/views/basecontrollers.py	Tue Apr 22 16:39:19 2014 +0200
@@ -92,7 +92,7 @@
     def publish(self, rset=None):
         """log in the instance"""
         path = self._cw.form.get('postlogin_path', '')
-        # redirect expect a URL, not a path. Also path may contains a query
+        # Redirect expects a URL, not a path. Also path may contain a query
         # string, hence should not be given to _cw.build_url()
         raise Redirect(self._cw.base_url() + path)
 
--- a/web/views/urlpublishing.py	Wed Mar 26 12:30:52 2014 +0100
+++ b/web/views/urlpublishing.py	Tue Apr 22 16:39:19 2014 +0200
@@ -97,7 +97,7 @@
         self.evaluators = sorted(evaluators, key=lambda x: x.priority)
 
     def process(self, req, path):
-        """Given a URL (essentialy caracterized by a path on the
+        """Given a URL (essentially characterized by a path on the
         server, but additional information may be found in the request
         object), return a publishing method identifier
         (e.g. controller) and an optional result set.