Skip to content

Hint Error Bubbling for Collections Edit #3341

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.

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

Closed
wants to merge 3 commits into from
Closed

Hint Error Bubbling for Collections Edit #3341

wants to merge 3 commits into from

Conversation

peterrehm
Copy link
Contributor

Added hint regarding the error bubbling default setting on collection entities based on the discussion in #2559.

I have added it to the Valid constraint as well as the cascade_validation setting since you need either setting when validating embedded collections.

By default the :doc:`collection Field Type </reference/forms/types/collection>` has enabled the option ``error_bubbling``
which passes the errors to the parent form. If you want to attach the errors
to the locations where they actually occure you have to set ``error_bubbling``
to ``false``.
Copy link
Member

Choose a reason for hiding this comment

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

the content of the tip should be indented by 4 spaces

@peterrehm
Copy link
Contributor Author

Updated according to the comments.

By default the ``error_bubbling`` option is enabled for the
:doc:`collection Field Type </reference/forms/types/collection>` which passes the errors to the parent form.
If you want to attach the errors to the locations where they
actually occure you have to set ``error_bubbling`` to ``false``.
Copy link
Member

Choose a reason for hiding this comment

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

Wrap lines after the first word that crosses the 72nd character. Thus, the entire tip would look like this:

.. tip::

    By default the ``error_bubbling`` option is enabled for the
    :doc:`collection Field Type </reference/forms/types/collection>` which
    passes the errors to the parent form. If you want to attach the errors
    to the locations where they actually occure you have to set ``error_bubbling``
    to ``false``.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Even when it is just a link? I took care not to be longer than 72 characters excluding the meta information.

Copy link
Member

Choose a reason for hiding this comment

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

Yes, the line length is not meaned for rendering, Sphinx just removes all line feeds from a file. It's meaned to be easier to read when reading the source code and reviewing patches.

Copy link
Member

Choose a reason for hiding this comment

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

Yes, this is mainly related to horizontal scrollbars in editors. And those are there regardless if it is meta information or "real" text. :)

@peterrehm
Copy link
Contributor Author

Okay, fixed :)

@xabbuh
Copy link
Member

xabbuh commented Dec 15, 2013

👍 nice work!

weaverryan added a commit that referenced this pull request Dec 26, 2013
@weaverryan
Copy link
Member

Good work Peter! I've patched this into the 2.3 branch at sha: 163ad78, sha: e63a16f and sha: dda001f

Thanks for opening the issue and fixing it :).

Cheers!

@weaverryan weaverryan closed this Dec 26, 2013
@peterrehm peterrehm deleted the form-error-bubbling-hint branch August 23, 2014 14:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants