Improve documentation

meziantou · Oct 24, 2022 · 0a8be75 · 0a8be75
1 parent 0796a39
commit 0a8be75
Show file tree

Hide file tree

Showing 5 changed files with 15 additions and 9 deletions.
diff --git a/docs/Rules/MA0116.md b/docs/Rules/MA0116.md
@@ -2,7 +2,7 @@
 
 Detect when `[SupplyParameterFromQuery]` attributes are used without the `[Parameter]` attributes.
 
-````c#
+````razor
 using Microsoft.AspNetCore.Components;
 
 @code {

diff --git a/docs/Rules/MA0117.md b/docs/Rules/MA0117.md
@@ -2,7 +2,7 @@
 
 Detect when `[EditorRequired]` attributes are used without the `[Parameter]` attribute.
 
-````c#
+````razor
 using Microsoft.AspNetCore.Components;
 
 @code {

diff --git a/docs/Rules/MA0118.md b/docs/Rules/MA0118.md
@@ -2,7 +2,7 @@
 
 Methods marked as `[JSInvokable]` must be public.
 
-````
+````c#
 using Microsoft.JSInterop;
 
 class Test

diff --git a/docs/Rules/MA0119.md b/docs/Rules/MA0119.md
@@ -24,5 +24,10 @@ class MyComponent : ComponentBase
     {
         await JS.InvokeVoidAsync("dummy");  // non-compliant
     }
+
+    private async Task OtherMethod()
+    {
+        await JS.InvokeVoidAsync("dummy");  // ok
+    }
 }
 ````
diff --git a/docs/Rules/MA0120.md b/docs/Rules/MA0120.md
@@ -2,11 +2,12 @@
 
 Simplify the usage of `IJSRuntime` or `IJSInProcessRuntime` when the returned value is not used.
 
-````
-IJSInProcessRuntime js = null;
-await js.InvokeVoidAsync(""dummy""); // compliant
-var result = await js.InvokeAsync<object>(""dummy""); // compliant
-Console.WriteLine(await js.InvokeAsync<object>(""dummy"")); // compliant 
+````c#
+IJSInProcessRuntime js = ...;
+
+await js.InvokeVoidAsync("dummy"); // compliant
+var result = await js.InvokeAsync<object>("dummy"); // compliant
+Console.WriteLine(await js.InvokeAsync<object>("dummy")); // compliant 
 
-await js.InvokeAsync<object>(""dummy""); // not-compliant
+await js.InvokeAsync<object>("dummy"); // not-compliant => use InvokeVoidAsync
 ````
-Original file line number
+Diff line change
@@ Expand Up / @@ -2,7 +2,7 @@ @@
     Detect when `[SupplyParameterFromQuery]` attributes are used without the `[Parameter]` attributes.
-    ````c#
+    ````razor
     using Microsoft.AspNetCore.Components;
     @code {
@@ Expand Down @@