Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Documenting the virtual option for types where it makes sense. #2401

Merged
merged 1 commit into from Mar 31, 2013
Merged

Documenting the virtual option for types where it makes sense. #2401

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
4 changes: 4 additions & 0 deletions reference/forms/types/birthday.rst
View file
Open in desktop
Expand Up @@ -31,6 +31,7 @@ option defaults to 120 years ago to the current year.
| | - `user_timezone`_ |
| | - `invalid_message`_ |
| | - `invalid_message_parameters`_ |
| | - `virtual`_ |
+----------------------+------------------------------------------------------------------------------------------------------------------------+
| Parent type | :doc:`date</reference/forms/types/date>` |
+----------------------+------------------------------------------------------------------------------------------------------------------------+
Expand Down Expand Up @@ -75,3 +76,6 @@ These options inherit from the :doc:`date</reference/forms/types/field>` type:

.. include:: /reference/forms/types/options/invalid_message_parameters.rst.inc

These options inherit from the :doc:`date</reference/forms/types/form>` type:

.. include:: /reference/forms/types/options/virtual.rst.inc
5 changes: 5 additions & 0 deletions reference/forms/types/choice.rst
View file
Open in desktop
Expand Up @@ -26,6 +26,7 @@ option.
| options | - `label`_ |
| | - `read_only`_ |
| | - `error_bubbling`_ |
| | - `virtual`_ |
+-------------+-----------------------------------------------------------------------------+
| Parent type | :doc:`form</reference/forms/types/form>` (if expanded), ``field`` otherwise |
+-------------+-----------------------------------------------------------------------------+
Expand Down Expand Up @@ -119,3 +120,7 @@ These options inherit from the :doc:`field</reference/forms/types/field>` type:
.. include:: /reference/forms/types/options/read_only.rst.inc

.. include:: /reference/forms/types/options/error_bubbling.rst.inc

These options inherit from the :doc:`date</reference/forms/types/form>` type:

.. include:: /reference/forms/types/options/virtual.rst.inc
7 changes: 6 additions & 1 deletion reference/forms/types/date.rst
View file
Open in desktop
Expand Up @@ -32,6 +32,7 @@ day, and year) or three select boxes (see the `widget_` option).
+----------------------+-----------------------------------------------------------------------------+
| Inherited | - `invalid_message`_ |
| options | - `invalid_message_parameters`_ |
| | - `virtual`_ |
+----------------------+-----------------------------------------------------------------------------+
| Parent type | ``field`` (if text), ``form`` otherwise |
+----------------------+-----------------------------------------------------------------------------+
Expand Down Expand Up @@ -120,4 +121,8 @@ These options inherit from the :doc:`field</reference/forms/types/field>` type:

.. include:: /reference/forms/types/options/invalid_message.rst.inc

.. include:: /reference/forms/types/options/invalid_message_parameters.rst.inc
.. include:: /reference/forms/types/options/invalid_message_parameters.rst.inc

These options inherit from the :doc:`date</reference/forms/types/form>` type:

.. include:: /reference/forms/types/options/virtual.rst.inc
7 changes: 6 additions & 1 deletion reference/forms/types/datetime.rst
View file
Open in desktop
Expand Up @@ -31,6 +31,7 @@ data can be a ``DateTime`` object, a string, a timestamp or an array.
+----------------------+-----------------------------------------------------------------------------+
| Inherited | - `invalid_message`_ |
| options | - `invalid_message_parameters`_ |
| | - `virtual`_ |
+----------------------+-----------------------------------------------------------------------------+
| Parent type | :doc:`form</reference/forms/types/form>` |
+----------------------+-----------------------------------------------------------------------------+
Expand Down Expand Up @@ -104,4 +105,8 @@ These options inherit from the :doc:`field</reference/forms/types/field>` type:

.. include:: /reference/forms/types/options/invalid_message.rst.inc

.. include:: /reference/forms/types/options/invalid_message_parameters.rst.inc
.. include:: /reference/forms/types/options/invalid_message_parameters.rst.inc

These options inherit from the :doc:`date</reference/forms/types/form>` type:

.. include:: /reference/forms/types/options/virtual.rst.inc
7 changes: 7 additions & 0 deletions reference/forms/types/options/virtual.rst.inc
View file
Open in desktop
@@ -0,0 +1,7 @@
virtual
~~~~~~~

**type**: ``boolean`` **default**: ``false``

This option determines if the form will be mapped with data. This can be usefull
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There is a little typo here: usefull -> useful

if you need a form to structure the view.
7 changes: 6 additions & 1 deletion reference/forms/types/time.rst
View file
Open in desktop
Expand Up @@ -26,6 +26,7 @@ as a ``DateTime`` object, a string, a timestamp or an array.
+----------------------+-----------------------------------------------------------------------------+
| Inherited | - `invalid_message`_ |
| options | - `invalid_message_parameters`_ |
| | - `virtual`_ |
+----------------------+-----------------------------------------------------------------------------+
| Parent type | form |
+----------------------+-----------------------------------------------------------------------------+
Expand Down Expand Up @@ -115,4 +116,8 @@ These options inherit from the :doc:`field</reference/forms/types/field>` type:

.. include:: /reference/forms/types/options/invalid_message.rst.inc

.. include:: /reference/forms/types/options/invalid_message_parameters.rst.inc
.. include:: /reference/forms/types/options/invalid_message_parameters.rst.inc

These options inherit from the :doc:`date</reference/forms/types/form>` type:

.. include:: /reference/forms/types/options/virtual.rst.inc