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.

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

replacing deprecated usage of True, False, Null validators in docs #5677

Closed
wants to merge 4 commits into from

Conversation

stampycode
Copy link

related: #5665

@xabbuh
Copy link
Member

xabbuh commented Sep 8, 2015

Nice work @stampycode. These changes should imo be made for the 2.3 branch, but we can (probably) easily apply them there.

@stampycode Is this based off the 2.7 branch or off 2.3?

@stampycode
Copy link
Author

This is based off 2.7, since that's the first version in which the deprecations were made (I think).

@xabbuh
Copy link
Member

xabbuh commented Sep 9, 2015

I think it's totally fine if we merge it into the 2.3 branch (the code was updated there too).

@weaverryan @wouterj @javiereguiluz What do you think?

@javiereguiluz
Copy link
Member

@xabbuh I agree with you. Let's merge it in 2.3 because this change was exceptionally made in that branch too.


.. include:: /reference/constraints/_payload-option.rst.inc
.. include:: /reference/constraints/IsFalse.rst
Copy link
Member

Choose a reason for hiding this comment

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

instead of including the IsFalse documentation, I prefer to add a link to this docs in the caution above. So we end up with:

.. caution::

    The ``False`` constraint is deprecated since Symfony 2.7 and will
    be removed in 3.0. Use the :doc:`/reference/constraints/IsFalse` constraint
    instead.

Copy link
Member

Choose a reason for hiding this comment

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

agreed

Copy link
Member

Choose a reason for hiding this comment

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

btw, including it does weird things, as it also includes the title

@weaverryan
Copy link
Member

👍 for 2.3 - if that's what we did in the code

weaverryan added a commit that referenced this pull request Oct 15, 2015
…ors in docs (Tim Stamp)

This PR was submitted for the 2.7 branch but it was merged into the 2.3 branch instead (closes #5677).

Discussion
----------

replacing deprecated usage of True, False, Null validators in docs

related: #5665

Commits
-------

9a5ea56 Updating book examples to not use deprecated validation methods
627d74d Updated constraint reference docs for Null->IsNull, False->IsFalse, True->IsTrue
a90ea7c Creating placeholder constraint rst docs for deprecated usage
639be4b Renaming constraint rst files to Is* to preserve edit history
@weaverryan
Copy link
Member

Thanks @stampycode! I've merged this into the 2.3 branch and merged up from there.

@weaverryan weaverryan closed this Oct 15, 2015
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants