Commit 539230d8 authored by LE GAC Renaud's avatar LE GAC Renaud
Browse files

Use the construct Note.

parent fea673fe
......@@ -74,7 +74,7 @@ def _to_field(field, linkedcombo=True, **kwargs):
The association is defined in the dictionary
:const:`FTYPE_TO_XTYPE`.
.. attention::
Warning:
It is recommended to used the more general method :meth:`to_field`
which also understands :class:`.FieldContainer`.
......@@ -178,7 +178,7 @@ def to_field(field, composite=True, linkedcombo=True, **kwargs):
:class:`.FieldContainer` and takes into account
the :class:`.FieldsModifier` instructions.
.. note::
Note:
The return configurator is a :class:`.Field`.
However it can be a :class:`.ComboBox`,
a :class:`.FieldDate`,
......@@ -187,7 +187,7 @@ def to_field(field, composite=True, linkedcombo=True, **kwargs):
The association is defined in the dictionary
:const:`FTYPE_TO_XTYPE`.
.. note::
Note:
The database fields can be organized in
:class:`.FieldContainer` in the application
model using the modifiers
......
......@@ -146,13 +146,13 @@ class DbSvc(BaseSvc):
* the second element contains only the left join conditions or an empty string.
* the third element contains only the filter conditions or an empty string.
.. note::
Note:
All elements of the list are ANDED in the web2py query
.. note::
Note:
comparison operators are ``==, !=, <, >, <=, >=``
.. note::
Note:
Boolean operators are ``&, |``
"""
......@@ -284,7 +284,7 @@ class DbSvc(BaseSvc):
Raises:
DbSvcException: when the database table does not exists
..note::
Note:
The method works with regular and alias tables.
"""
......
......@@ -19,7 +19,7 @@ class Base(Storage):
and ``append_plugins``. They are required to append ``items``
and ``plugins``.
.. note::
Note:
A protection is set to avoid changing the ``xtype`` of the element.
"""
......@@ -132,7 +132,8 @@ class FieldSet(Base):
class FieldText(Base):
"""Configurator for ``Ext.form.field.Text``.
:note: Regular expression for the validation can be written as a string.
Note:
Regular expression for the validation can be written as a string.
"""
xtype = 'textfield'
......@@ -173,7 +174,7 @@ class GridColumn(dict):
class GridColumnModel(list):
"""Configurator for ``Ext.grid.ColumnModel``.
.. note::
Note:
It is implemented as a ``list`` of :class:`.GridColumn`.
"""
......
......@@ -96,7 +96,7 @@ class FieldsModifier(Modifier):
They can be super seed by the keyword arguments.
.. note::
Note:
* Each ``field`` is identified by its database field name.
* ``field`` should belong to the database table defined in the constructor.
* The first ``field`` is the main field of the ``FieldContainer``.
......
......@@ -26,7 +26,7 @@ def configure_forms(db, **extjs):
list of forms to be modified. They are identified by their
associated table name.
.. note::
Note:
The keyword arguments define values for the Ext JS configuration
options of he ``Ext.form.Panel`` class.
......
......@@ -127,11 +127,11 @@ def encode_field(*args):
Returns:
str:
.. note::
Note:
useful to build database field name like ``TableField``
or ``TableFieldFunc``.
.. note::
Note:
The Ext JS ComboBox don't decode properly any separator between
table and field like table+field. Therefore choice for the encoding
are very limited.
......@@ -173,7 +173,7 @@ def get_all_tables(dal):
Returns:
list:
.. note::
Note:
It is recommend to use standard iterator provided by
the gluon.dal.DAL class. However by construction, they ignore
alias table.
......@@ -189,7 +189,7 @@ def get_create_id(table, **kwargs):
If the record does not exist it is created with the values
specified in the keywords arguments.
Example::
Example:
id = get_create_id(db.person, first_name="Joe", last_name="Doe")
......
......@@ -53,7 +53,7 @@ class Node(object):
hidden (list): list of children to be hidden.
.. note::
Note:
* Leaf names are translated in the current language
* Leaf names are sorted in alphabetic order
......
......@@ -41,7 +41,7 @@ class AddStore(object):
For an ``Ext.data.ArrayStore`` the keyword ``fields`` and ``data``
have to be defined. For more details see the ExtJS documentation.
.. note::
Note:
The key associated to this store in the persistent dictionary
is the ``storeId``. Its value is derived from the store name,
*e.g.* ``nameStore``.
......
......@@ -57,7 +57,7 @@ class ViewportModifier(Modifier):
Args:
args (list): list of :class:`.Node`
.. note::
Note:
Elements of the list equal to ``None`` are ignored.
This feature is useful when the list of nodes depend on user role.
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment