DOC Document deprecation of BaseElement::getDescription() (#521)

silverstripe · May 29, 2024 · 50e0b9a · 50e0b9a
1 parent 1fc1f50
commit 50e0b9a
Showing 1 changed file with 3 additions and 1 deletion.
diff --git a/en/08_Changelogs/5.3.0.md b/en/08_Changelogs/5.3.0.md
@@ -11,6 +11,7 @@ title: 5.3.0 (unreleased)
   - [Validation for elemental content blocks when saving individual blocks](#elemental-validation)
   - [Support for `JOIN` in SQL `UPDATE`](#sql-update-join)
   - [Other new features](#other-new-features)
+  - [API changes](#api-changes)
 - [Bug fixes](#bug-fixes)
 
 ## Features and enhancements
@@ -71,7 +72,8 @@ This is particularly helpful if you need to update columns in one table to match
 
 ## API changes
 
-Passing a non-array `$fields` argument to both [`FieldList::addFieldsToTab()`](api:SilverStripe\Forms\FieldList::addFieldsToTab()) and [`FieldList::removeFieldsFromTab()`](api:SilverStripe\Forms\FieldList::removeFieldsFromTab()) has been deprecated.
+- Passing a non-array `$fields` argument to both [`FieldList::addFieldsToTab()`](api:SilverStripe\Forms\FieldList::addFieldsToTab()) and [`FieldList::removeFieldsFromTab()`](api:SilverStripe\Forms\FieldList::removeFieldsFromTab()) has been deprecated.
+- The [`BaseElement::getDescription()`](api:DNADesign\Elemental\Models\BaseElement::getDescription()) method has been deprecated. To update the description of elemental blocks, use the [`description`](api:DNADesign\Elemental\Models\BaseElement->description) configuration property and the localisation API.
 
 ## Bug fixes