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

Rename ImportCompeted into ImportCompleted #12117

Merged
merged 7 commits into from Jul 14, 2023
Merged

Rename ImportCompeted into ImportCompleted #12117

merged 7 commits into from Jul 14, 2023

Conversation

jgcodes2020
Copy link
Contributor

What does the pull request do?

This PR properly fixes issue #11960.

What is the current behavior?

The interface Avalonia.Rendering.Composition.ICompositionImportedGpuObject currently uses ImportCompeted for a Task that completes when the import is completed.

What is the updated/expected behavior with this PR?

Practically identical, except that name is fixed.

How was the solution implemented (if it's not obvious)?

ImportCompeted was renamed to ImportCompleted. A separate ImportCompeted property was added that simply fetches ImportCompleted. I have [Obsolete]d the ImportCompeted property to encourage people to switch over to the new spelling.

Checklist

  • Added unit tests (if possible)? (N/A)
  • Added XML documentation to any related classes?
  • Consider submitting a PR to https://github.com/AvaloniaUI/Documentation with user documentation (GPU interop docs are currently not available yet)

Breaking changes

See Obsoletions/Deprecations section below.

Obsoletions / Deprecations

ICompositionImportedGpuObject.ImportCompeted is obsoleted (since it's a typo). The replacement is
ImportCompleted.

I have yet to discuss with the core team. (@grokys @kekekeks @danwalmsley)

Fixed issues

Fixes #11960

@jgcodes2020
Copy link
Contributor Author

@dotnet-policy-service agree

@maxkatz6
Copy link
Member

maxkatz6 commented Jul 10, 2023

@jgcodes2020 thanks! We support netstandard2.0 and that's why you can't use default interface implementations. Instead, you need to implement this member independently.
Also couple of notes:

  1. ICompositionGpuInterop should also be marked as not client implementabe
  2. You will need to run "nuke ValidateApiDiff" from the repo root in the command line, so it will update breaking changes file.

Copy link
Member

@maxkatz6 maxkatz6 left a comment

Choose a reason for hiding this comment

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

Thanks!
Looks good to me. I fixed CI build as well.

@maxkatz6 maxkatz6 enabled auto-merge July 13, 2023 21:22
@avaloniaui-team
Copy link
Contributor

You can test this PR using the following package version. 11.0.999-cibuild0037700-beta. (feed url: https://nuget-feed-all.avaloniaui.net/v3/index.json) [PRBUILDID]

@maxkatz6 maxkatz6 added this pull request to the merge queue Jul 13, 2023
@github-merge-queue github-merge-queue bot removed this pull request from the merge queue due to failed status checks Jul 13, 2023
@maxkatz6 maxkatz6 added this pull request to the merge queue Jul 14, 2023
Merged via the queue into AvaloniaUI:master with commit 6704df7 Jul 14, 2023
6 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

ICompositionImportedGpuImage.ImportCompeted should be called ImportCompleted
4 participants