Skip to content

Commit 0485bb7

Browse files
committed
docs: the longer explanation in the changelog, the upgrading section has actual tasks that need to be done when upgrading
1 parent a42a641 commit 0485bb7

2 files changed

Lines changed: 16 additions & 11 deletions

File tree

user_guide_src/source/changelogs/v4.1.6.rst

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,12 +7,26 @@ Release Date: Not released
77

88
.. contents::
99
:local:
10-
:depth: 1
10+
:depth: 2
1111

1212
BREAKING
1313
========
1414
- Multiple table names will no longer be stored in ``BaseBuilder::$tableName`` - an empty string will be used instead.
1515

16+
.. _changelog-v416-validation-changes:
17+
18+
Validation changes
19+
------------------
20+
- The previous version of the Validation can't handle an array item.
21+
Because of the bug fix, the validation results may be different,
22+
or raise an TypeError.
23+
But the previous version's results are probably incorrect.
24+
- The Validation separated the validation process of multiple field
25+
like ``contacts.*.name`` and single field.
26+
When a single field has an array data, the previous version validates each element of the array.
27+
The validation rule gets an element of the array as the parameter.
28+
On the other hand, the current version passes the array to the validation rule as a whole.
29+
1630
Enhancements
1731
============
1832
- Database pane on debug toolbar now displays location where Query was called from. Also displays full backtrace.

user_guide_src/source/installation/upgrade_416.rst

Lines changed: 1 addition & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -12,16 +12,7 @@ Breaking Changes
1212
Validation result changes
1313
=========================
1414

15-
The previous version of the Validation can't handle an array item.
16-
Because of the bug fix, the validation results may be different,
17-
or raise an TypeError.
18-
But the previous version's results are probably incorrect.
19-
20-
And the Validation separated the validation process of multiple field
21-
like ``contacts.*.name`` and single field.
22-
When a single field has an array data, the previous version validates each element of the array.
23-
The validation rule gets an element of the array as the parameter.
24-
On the other hand, the current version passes the array to the validation rule as a whole.
15+
Due to a bug fix, the Validation now might change the validation results when you validate an array item (see :ref:`Changelog <changelog-v416-validation-changes>`). So check the validation results for all the code that validates the array. Validating multiple fields like ``contacts.*.name`` is not affected.
2516

2617
Breaking Enhancements
2718
*********************

0 commit comments

Comments
 (0)