Modify rule S6424: Migrate to new educational format (#1867)

This commit is contained in:
Čaba Šagi 2023-05-15 11:58:47 +02:00 committed by GitHub
parent 02086b65a5
commit 67102251e4
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -1,6 +1,6 @@
== Why is this an issue?
The recommended way to access Azure Durable Entities is Interfaces via generated proxy objects.
The recommended way to access Azure Durable Entities is through generated proxy objects with the help of interfaces.
The following restrictions, during interface design, are enforced:
@ -16,7 +16,7 @@ This rule raises an issue in case any of the restrictions above is not respected
=== Noncompliant code example
[source,csharp]
[source,csharp,diff-id=1,diff-type=noncompliant]
----
namespace Foo // Noncompliant, must be defined in the same assembly as the entity class that implements it
{
@ -52,7 +52,7 @@ namespace Bar
=== Compliant solution
[source,csharp]
[source,csharp,diff-id=1,diff-type=compliant]
----
namespace Bar
{
@ -88,4 +88,7 @@ namespace Bar
== Resources
* https://docs.microsoft.com/en-us/azure/azure-functions/durable/durable-functions-dotnet-entities#restrictions-on-entity-interfaces[Restrictions on Entity Interfaces]
* https://docs.microsoft.com/en-us/azure/azure-functions/durable/durable-functions-entities?tabs=csharp[Durable Entities]
* https://docs.microsoft.com/en-us/azure/azure-functions/durable/durable-functions-entities?tabs=csharp[Durable Entities]
* https://learn.microsoft.com/en-us/dotnet/api/microsoft.azure.webjobs.extensions.durabletask.idurableentitycontext.signalentity?view=azure-dotnet[IDurableEntityContext.SignalEntity]
* https://learn.microsoft.com/en-us/dotnet/api/microsoft.azure.webjobs.extensions.durabletask.idurableentityclient.signalentityasync?view=azure-dotnet[IDurableEntityClient.SignalEntityAsync]
* https://learn.microsoft.com/en-us/dotnet/api/microsoft.azure.webjobs.extensions.durabletask.idurableorchestrationcontext.createentityproxy?view=azure-dotnet[IDurableOrchestrationContext.CreateEntity]