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.

Sign up for GitHub

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

Clarify the 2.0 release notes #16814

Merged
merged 4 commits into from
Oct 1, 2024
Merged

Clarify the 2.0 release notes #16814

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
1c82546
Clerify the 2.0 release notes
MikeAlhayek Oct 1, 2024
3d089e7
Merge branch 'main' into ma/update-2.0-release-notes
MikeAlhayek Oct 1, 2024
52f4c9b
fix
MikeAlhayek Oct 1, 2024
d775e0b
Merge branch 'ma/update-2.0-release-notes' of https://github.com/Orch…
MikeAlhayek Oct 1, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 16 additions & 16 deletions src/docs/releases/2.0.0.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -289,40 +289,40 @@ 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:
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)`

and removed the following methods:
the following methods have been removed, with updated alternatives provided:

- `Task<IDisplayResult> DisplayAsync(TModel model, IUpdateModel updater)`
- `IDisplayResult Display(TModel model, IUpdateModel updater)`
- `Task<IDisplayResult> UpdateAsync(TModel model, IUpdateModel updater)`
- `Task<IDisplayResult> EditAsync(TModel model, IUpdateModel updater)`
- `IDisplayResult Edit(TModel model, IUpdateModel updater)`
- `Task<IDisplayResult> 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<IDisplayResult> UpdateAsync(TModel model, IUpdateModel updater)` → Use `UpdateAsync(TModel model, UpdateEditorContext context)` where the `Updater` property is available via `context`.
- `Task<IDisplayResult> 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<IDisplayResult> CombineAsync(params IDisplayResult[] results)`
- `Task<IDisplayResult> CombineAsync(IEnumerable<IDisplayResult> 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)`
- `Edit(TSection section, BuildEditorContext context)`
- `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:
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
And the following methods have been removed, with updated alternatives:
The following methods have been removed, with updated alternatives:

Copy link
Member Author

@MikeAlhayek MikeAlhayek Oct 1, 2024 •
edited
Loading

Choose a reason for hiding this comment

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

@hishamco why do you think this is better? its a continuation of the previous part.

Copy link
Member

Choose a reason for hiding this comment

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

Ok leave it


- `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.
Expand Down
Loading