cleanup

SimonCropp · Nov 7, 2023 · c003fb0 · c003fb0
1 parent e364d18
commit c003fb0
Show file tree

Hide file tree

Showing 13 changed files with 118 additions and 78 deletions.
diff --git a/contributing.md b/contributing.md
@@ -135,6 +135,7 @@ Example:
 
 using System.Diagnostics;
 using System.Diagnostics.CodeAnalysis;
+using Link = System.ComponentModel.DescriptionAttribute;
 
 namespace System.Runtime.CompilerServices;
 
@@ -158,6 +159,7 @@ namespace System.Runtime.CompilerServices;
 /// The specification for module initializers in the .NET runtime can be found here:
 /// https://github.com/dotnet/runtime/blob/master/docs/design/specs/Ecma-335-Augments.md#module-initializer
 /// </remarks>
+[Link("https://learn.microsoft.com/en-us/dotnet/api/system.runtime.compilerservices.moduleinitializerattribute?view=net-7.0")]
 [ExcludeFromCodeCoverage]
 [DebuggerNonUserCode]
 [AttributeUsage(
@@ -173,7 +175,7 @@ sealed class ModuleInitializerAttribute :
 
 #endif
 ```
-<sup><a href='/src/Polyfill/ModuleInitializerAttribute.cs#L1-L43' title='Snippet source file'>snippet source</a> | <a href='#snippet-ModuleInitializerAttribute.cs' title='Start of snippet'>anchor</a></sup>
+<sup><a href='/src/Polyfill/ModuleInitializerAttribute.cs#L1-L45' title='Snippet source file'>snippet source</a> | <a href='#snippet-ModuleInitializerAttribute.cs' title='Start of snippet'>anchor</a></sup>
 <!-- endSnippet -->
 
 

diff --git a/src/Consume/Consume.cs b/src/Consume/Consume.cs
@@ -142,7 +142,7 @@ void CancellationTokenUnsafeRegister()
     {
         var source = new CancellationTokenSource();
         var token = source.Token;
-        token.UnsafeRegister((state) => {}, null);
+        token.UnsafeRegister(state => {}, null);
         token.UnsafeRegister((state, token) => {}, null);
     }
 

diff --git a/src/Polyfill/CallerArgumentExpressionAttribute.cs b/src/Polyfill/CallerArgumentExpressionAttribute.cs
@@ -4,21 +4,35 @@
 
 using System.Diagnostics;
 using System.Diagnostics.CodeAnalysis;
+using Link = System.ComponentModel.DescriptionAttribute;
 
 namespace System.Runtime.CompilerServices;
 
+/// <summary>
+/// Indicates that a parameter captures the expression passed for another parameter as a string.
+/// </summary>
 [ExcludeFromCodeCoverage]
 [DebuggerNonUserCode]
 [AttributeUsage(AttributeTargets.Parameter)]
+[Link("https://learn.microsoft.com/en-us/dotnet/api/system.runtime.compilerservices.callerargumentexpressionattribute")]
 #if PolyPublic
 public
 #endif
 sealed class CallerArgumentExpressionAttribute :
     Attribute
 {
+    /// <summary>
+    /// Initializes a new instance of the <see cref="CallerArgumentExpressionAttribute"/> class.
+    /// </summary>
+    /// <param name="parameterName">
+    /// The name of the parameter whose expression should be captured as a string.
+    /// </param>
     public CallerArgumentExpressionAttribute(string parameterName) =>
         ParameterName = parameterName;
 
+    /// <summary>
+    /// Gets the name of the parameter whose expression should be captured as a string.
+    /// </summary>
     public string ParameterName { get; }
 }
 

diff --git a/src/Polyfill/CompilerFeatureRequiredAttribute.cs b/src/Polyfill/CompilerFeatureRequiredAttribute.cs
@@ -4,6 +4,7 @@
 
 using System.Diagnostics;
 using System.Diagnostics.CodeAnalysis;
+using Link = System.ComponentModel.DescriptionAttribute;
 
 namespace System.Runtime.CompilerServices;
 
@@ -16,6 +17,7 @@ namespace System.Runtime.CompilerServices;
     validOn: AttributeTargets.All,
     AllowMultiple = true,
     Inherited = false)]
+[Link("https://learn.microsoft.com/en-us/dotnet/api/system.runtime.compilerservices.compilerfeaturerequiredattribute")]
 #if PolyPublic
 public
 #endif
@@ -25,6 +27,7 @@ sealed class CompilerFeatureRequiredAttribute :
     /// <summary>
     /// Initialize a new instance of <see cref="CompilerFeatureRequiredAttribute"/>
     /// </summary>
+    /// <param name="featureName">The name of the required compiler feature.</param>
     public CompilerFeatureRequiredAttribute(string featureName) =>
         FeatureName = featureName;
 

diff --git a/src/Polyfill/DisableRuntimeMarshallingAttribute.cs b/src/Polyfill/DisableRuntimeMarshallingAttribute.cs
@@ -4,6 +4,7 @@
 
 using System.Diagnostics;
 using System.Diagnostics.CodeAnalysis;
+using Link = System.ComponentModel.DescriptionAttribute;
 
 namespace System.Runtime.CompilerServices;
 
@@ -27,6 +28,7 @@ namespace System.Runtime.CompilerServices;
 [ExcludeFromCodeCoverage]
 [DebuggerNonUserCode]
 [AttributeUsage(AttributeTargets.Assembly)]
+[Link("https://learn.microsoft.com/en-us/dotnet/api/system.runtime.compilerservices.disableruntimemarshallingattribute")]
 #if PolyPublic
 public
 #endif

diff --git a/src/Polyfill/InterpolatedStringHandlerArgumentAttribute.cs b/src/Polyfill/InterpolatedStringHandlerArgumentAttribute.cs
@@ -4,6 +4,7 @@
 
 using System.Diagnostics;
 using System.Diagnostics.CodeAnalysis;
+using Link = System.ComponentModel.DescriptionAttribute;
 
 namespace System.Runtime.CompilerServices;
 
@@ -13,6 +14,7 @@ namespace System.Runtime.CompilerServices;
 [ExcludeFromCodeCoverage]
 [DebuggerNonUserCode]
 [AttributeUsage(AttributeTargets.Parameter)]
+[Link("https://learn.microsoft.com/en-us/dotnet/api/system.runtime.compilerservices.interpolatedstringhandlerargumentattribute")]
 #if PolyPublic
 public
 #endif

diff --git a/src/Polyfill/InterpolatedStringHandlerAttribute.cs b/src/Polyfill/InterpolatedStringHandlerAttribute.cs
@@ -4,12 +4,16 @@
 
 using System.Diagnostics;
 using System.Diagnostics.CodeAnalysis;
+using Link = System.ComponentModel.DescriptionAttribute;
 
 namespace System.Runtime.CompilerServices;
 
 using Targets = AttributeTargets;
 
-/// <summary>Indicates the attributed type is to be used as an interpolated string handler.</summary>
+/// <summary>
+/// Indicates the attributed type is to be used as an interpolated string handler.
+/// </summary>
+[Link("https://learn.microsoft.com/en-us/dotnet/api/system.runtime.compilerservices.interpolatedstringhandlerargumentattribute")]
 [ExcludeFromCodeCoverage]
 [DebuggerNonUserCode]
 [AttributeUsage(

diff --git a/src/Polyfill/ModuleInitializerAttribute.cs b/src/Polyfill/ModuleInitializerAttribute.cs
@@ -4,6 +4,7 @@
 
 using System.Diagnostics;
 using System.Diagnostics.CodeAnalysis;
+using Link = System.ComponentModel.DescriptionAttribute;
 
 namespace System.Runtime.CompilerServices;
 
@@ -27,6 +28,7 @@ namespace System.Runtime.CompilerServices;
 /// The specification for module initializers in the .NET runtime can be found here:
 /// https://github.com/dotnet/runtime/blob/master/docs/design/specs/Ecma-335-Augments.md#module-initializer
 /// </remarks>
+[Link("https://learn.microsoft.com/en-us/dotnet/api/system.runtime.compilerservices.moduleinitializerattribute?view=net-7.0")]
 [ExcludeFromCodeCoverage]
 [DebuggerNonUserCode]
 [AttributeUsage(

diff --git a/src/Polyfill/PolyfillExtensions_IEnumerable.cs b/src/Polyfill/PolyfillExtensions_IEnumerable.cs
@@ -145,7 +145,8 @@ static IEnumerable<TSource[]> ChunkIterator<TSource>(IEnumerable<TSource> source
                     {
                         // For all but the first chunk, the array will already be correctly sized.
                         // We can just store into it until either it's full or MoveNext returns false.
-                        TSource[] local = array; // avoid bounds checks by using cached local (`array` is lifted to iterator object as a field)
+                        // avoid bounds checks by using cached local (`array` is lifted to iterator object as a field)
+                        TSource[] local = array;
                         for (; (uint)i < (uint)local.Length && e.MoveNext(); i++)
                         {
                             local[i] = e.Current;

diff --git a/src/Polyfill/PolyfillExtensions_Task.cs b/src/Polyfill/PolyfillExtensions_Task.cs
@@ -21,15 +21,15 @@ public static async Task WaitAsync(
         this Task target,
         TimeSpan timeout)
     {
-        var cancellationSource = new CancellationTokenSource();
+        var cancelSource = new CancellationTokenSource();
         try
         {
-            await target.WaitAsync(timeout, cancellationSource.Token);
+            await target.WaitAsync(timeout, cancelSource.Token);
         }
         finally
         {
-            cancellationSource.Cancel();
-            cancellationSource.Dispose();
+            cancelSource.Cancel();
+            cancelSource.Dispose();
         }
     }
 
@@ -60,15 +60,15 @@ public static async Task<TResult> WaitAsync<TResult>(
         this Task<TResult> target,
         TimeSpan timeout)
     {
-        var cancellationSource = new CancellationTokenSource();
+        var cancelSource = new CancellationTokenSource();
         try
         {
-            return await target.WaitAsync(timeout, cancellationSource.Token);
+            return await target.WaitAsync(timeout, cancelSource.Token);
         }
         finally
         {
-            cancellationSource.Cancel();
-            cancellationSource.Dispose();
+            cancelSource.Cancel();
+            cancelSource.Dispose();
         }
     }
 

diff --git a/src/Tests/PolyfillExtensionsTests_CancellationToken.cs b/src/Tests/PolyfillExtensionsTests_CancellationToken.cs
@@ -6,10 +6,11 @@ public void CancellationToken_Register_Exceptions()
         CancellationToken token = default;
 
 #nullable disable
-        Assert.Throws<ArgumentNullException>(() => token.Register((Action<object, CancellationToken>)null, null));
+        Assert.Throws<ArgumentNullException>(() => token.Register((Action<object, CancellationToken>) null, null));
 
-        Assert.Throws<ArgumentNullException>(() => token.UnsafeRegister((Action<object>)null, null));
-        Assert.Throws<ArgumentNullException>(() => token.UnsafeRegister((Action<object, CancellationToken>)null, null));
+        // ReSharper disable once RedundantCast
+        Assert.Throws<ArgumentNullException>(() => token.UnsafeRegister((Action<object>) null, null));
+        Assert.Throws<ArgumentNullException>(() => token.UnsafeRegister((Action<object, CancellationToken>) null, null));
 #nullable enable
     }
 
@@ -18,52 +19,57 @@ public void CancellationToken_Register_Exceptions()
     [TestCase(true)]
     public static void CancellationToken_Register_ExecutionContextFlowsIfExpected(bool callbackWithToken)
     {
-        var cts = new CancellationTokenSource();
+        var cancelSource = new CancellationTokenSource();
 
-        const int Iters = 5;
-        int invoked = 0;
+        const int iterations = 5;
+        var invoked = 0;
 
-        AsyncLocal<int> al = new AsyncLocal<int>();
-        for (int i = 1; i <= Iters; i++)
+        var asyncLocal = new AsyncLocal<int>();
+        for (var i = 1; i <= iterations; i++)
         {
-            bool flowExecutionContext = i % 2 == 0;
+            var flowExecutionContext = i % 2 == 0;
 
-            al.Value = i;
+            asyncLocal.Value = i;
             Action<object?> callback = s =>
             {
                 invoked++;
-                Assert.AreEqual(flowExecutionContext ? (int)s! : 0, al.Value);
+                Assert.AreEqual(flowExecutionContext ? (int) s! : 0, asyncLocal.Value);
             };
 
-            CancellationToken ct = cts.Token;
+            var token = cancelSource.Token;
             if (flowExecutionContext && callbackWithToken)
             {
-                ct.Register((s, t) =>
-                {
-                    Assert.AreEqual(ct, t);
-                    callback(s);
-                }, i);
+                token.Register(
+                    (s, t) =>
+                    {
+                        Assert.AreEqual(token, t);
+                        callback(s);
+                    },
+                    i);
             }
             else if (flowExecutionContext)
             {
-                ct.Register(callback, i);
+                token.Register(callback, i);
             }
             else if (callbackWithToken)
             {
-                ct.UnsafeRegister((s, t) =>
-                {
-                    Assert.AreEqual(ct, t);
-                    callback(s);
-                }, i);
+                token.UnsafeRegister(
+                    (s, t) =>
+                    {
+                        Assert.AreEqual(token, t);
+                        callback(s);
+                    },
+                    i);
             }
             else
             {
-                ct.UnsafeRegister(callback, i);
+                token.UnsafeRegister(callback, i);
             }
         }
-        al.Value = 0;
 
-        cts.Cancel();
-        Assert.AreEqual(Iters, invoked);
+        asyncLocal.Value = 0;
+
+        cancelSource.Cancel();
+        Assert.AreEqual(iterations, invoked);
     }
-}
+}