From 1c8254641aa27d6008bde45835dc65f6589be560 Mon Sep 17 00:00:00 2001 From: Mike Alhayek Date: Tue, 1 Oct 2024 10:27:11 -0700 Subject: [PATCH 1/2] Clerify the 2.0 release notes --- src/docs/releases/2.0.0.md | 35 +++++++++++++++-------------------- 1 file changed, 15 insertions(+), 20 deletions(-) diff --git a/src/docs/releases/2.0.0.md b/src/docs/releases/2.0.0.md index 8f01598c42d..4545cc25473 100644 --- a/src/docs/releases/2.0.0.md +++ b/src/docs/releases/2.0.0.md @@ -289,25 +289,20 @@ Here are the updated signatures: These adjustments ensure compatibility and adherence to the latest conventions within the `DisplayDriver` class. -Additionally, we've enhanced display performance by streamlining the display drivers. To achieve this, the following methods have been marked as obsolete: - -- `IDisplayResult Display(TModel model)` -- `IDisplayResult Edit(TModel model)` - -and removed the following methods: +Additionally, the following methods have been removed, with updated alternatives provided: -- `Task DisplayAsync(TModel model, IUpdateModel updater)` -- `IDisplayResult Display(TModel model, IUpdateModel updater)` -- `Task UpdateAsync(TModel model, IUpdateModel updater)` -- `Task EditAsync(TModel model, IUpdateModel updater)` -- `IDisplayResult Edit(TModel model, IUpdateModel updater)` +- `Task DisplayAsync(TModel model, IUpdateModel updater)` → Use `DisplayAsync(TModel model, BuildDisplayContext context)` where the `Updater` property is available via `context`. +- `IDisplayResult Display(TModel model, IUpdateModel updater)` → Use `Display(TModel model, BuildDisplayContext context)` where the `Updater` property is available via `context`. +- `Task UpdateAsync(TModel model, IUpdateModel updater)` → Use `UpdateAsync(TModel model, UpdateEditorContext context)` where the `Updater` property is available via `context`. +- `Task EditAsync(TModel model, IUpdateModel updater)` → Use `EditAsync(TModel model, BuildEditorContext context)` where the `Updater` property is available via `context`. +- `IDisplayResult Edit(TModel model, IUpdateModel updater)` → Use `Edit(TModel model, BuildEditorContext context)` where the `Updater` property is available via `context`. -At the same time, we've introduced the following static methods in the `DisplayDriverBase`: +In addition, we've introduced new static methods in the `DisplayDriverBase` class: - `Task CombineAsync(params IDisplayResult[] results)` - `Task CombineAsync(IEnumerable results)` -Similar refactoring was done to `SectionDisplayDriver` class. The following methods have been marked as obsolete: +The same refactoring applies to the `SectionDisplayDriver` class. The following methods are now obsolete: - `Display(TSection section, BuildDisplayContext context)` - `Display(TSection section)` @@ -315,14 +310,14 @@ Similar refactoring was done to `SectionDisplayDriver` class. The following meth - `UpdateAsync(TSection section, UpdateEditorContext context)` - `UpdateAsync(TSection section, IUpdateModel updater, string groupId)` -and removed the following methods: +And the following methods have been removed, with updated alternatives: -- `UpdateAsync(TModel model, TSection section, IUpdateModel updater, UpdateEditorContext context)` -- `UpdateAsync(TSection section, IUpdateModel updater, UpdateEditorContext context)` -- `UpdateAsync(TSection section, IUpdateModel updater, string groupId)` -- `UpdateAsync(TSection section, UpdateEditorContext context)` -- `EditAsync(TSection section, BuildEditorContext context)` -- `DisplayAsync(TSection section, BuildDisplayContext context)` +- `UpdateAsync(TModel model, TSection section, IUpdateModel updater, UpdateEditorContext context)` → Use `UpdateAsync(TModel model, TSection section, UpdateEditorContext context)` where the `Updater` is available via `context`. +- `UpdateAsync(TSection section, IUpdateModel updater, UpdateEditorContext context)` → Use `UpdateAsync(TModel model, TSection section, UpdateEditorContext context)` where the `Updater` is available via `context`. +- `UpdateAsync(TSection section, IUpdateModel updater, string groupId)` → Use `UpdateAsync(TModel model, TSection section, UpdateEditorContext context)` where the `Updater` and `GroupId` properties are available via `context`. +- `UpdateAsync(TSection section, UpdateEditorContext context)` → Use `UpdateAsync(TModel model, TSection section, UpdateEditorContext context)` where the `Updater` is available via `context`. +- `EditAsync(TSection section, BuildEditorContext context)` → Use `EditAsync(TModel model, TSection section, BuildEditorContext context)` where the `Updater` is available via `context`. +- `DisplayAsync(TSection section, BuildDisplayContext context)` → Use `DisplayAsync(TModel model, TSection section, BuildDisplayContext context)` where the `Updater` is available via `context`. !!! note To enhance your project's performance, address any warnings generated by the use of these obsolete methods. Please note that these methods will be removed in the next major release. From 52f4c9b6a3308d7c40676b8c73223a22e02163e2 Mon Sep 17 00:00:00 2001 From: Mike Alhayek Date: Tue, 1 Oct 2024 10:33:18 -0700 Subject: [PATCH 2/2] fix --- src/docs/releases/2.0.0.md | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/src/docs/releases/2.0.0.md b/src/docs/releases/2.0.0.md index 4545cc25473..b5c279419d2 100644 --- a/src/docs/releases/2.0.0.md +++ b/src/docs/releases/2.0.0.md @@ -289,7 +289,12 @@ Here are the updated signatures: These adjustments ensure compatibility and adherence to the latest conventions within the `DisplayDriver` class. -Additionally, the following methods have been removed, with updated alternatives provided: +Additionally, we've enhanced display performance by optimizing the display drivers. The following methods have been marked as obsolete: + +- `IDisplayResult Display(TModel model)` +- `IDisplayResult Edit(TModel model)` + +the following methods have been removed, with updated alternatives provided: - `Task DisplayAsync(TModel model, IUpdateModel updater)` → Use `DisplayAsync(TModel model, BuildDisplayContext context)` where the `Updater` property is available via `context`. - `IDisplayResult Display(TModel model, IUpdateModel updater)` → Use `Display(TModel model, BuildDisplayContext context)` where the `Updater` property is available via `context`.