Improved XML docs.

Author: electricessence

Core/Core/QueryResult.cs

@@ -151,11 +151,11 @@ public static class QueryResultExtensions
     /// <returns>An enumerable that dequeues the results and returns a column mapped dictionary for each entry</returns>
     public static IEnumerable<Dictionary<string, object?>> DequeueAsMappedDictionaries(this QueryResult<Queue<object?[]>> source)
     {
-        if (source is null) throw new ArgumentNullException(nameof(source));
-
-        return DequeueAsMappedDictionariesCore(source);
+		return source is null
+            ? throw new ArgumentNullException(nameof(source))
+            : DequeueAsMappedDictionariesCore(source);
 
-        static IEnumerable<Dictionary<string, object?>> DequeueAsMappedDictionariesCore(QueryResult<Queue<object?[]>> source)
+		static IEnumerable<Dictionary<string, object?>> DequeueAsMappedDictionariesCore(QueryResult<Queue<object?[]>> source)
         {
             Contract.EndContractBlock();
 
@@ -240,11 +240,11 @@ public static ValueTask<IEnumerable<T>> DequeueAs<T>(this ValueTask<QueryResult<
     /// <returns>An enumerable that dequeues the results and returns a column mapped dictionary for each entry</returns>
     public static IEnumerable<Dictionary<string, object?>> AsMappedDictionaries(this QueryResult<IEnumerable<object?[]>> source)
     {
-        if (source is null) throw new ArgumentNullException(nameof(source));
-
-        return AsMappedDictionariesCore(source);
+		return source is null
+            ? throw new ArgumentNullException(nameof(source))
+            : AsMappedDictionariesCore(source);
 
-        static IEnumerable<Dictionary<string, object?>> AsMappedDictionariesCore(QueryResult<IEnumerable<object?[]>> source)
+		static IEnumerable<Dictionary<string, object?>> AsMappedDictionariesCore(QueryResult<IEnumerable<object?[]>> source)
         {
             Contract.EndContractBlock();
 

Core/ExpressiveCommandBase.cs

@@ -19,6 +19,7 @@ namespace Open.Database.Extensions;
 /// <typeparam name="TReader">The type of reader created by the command.</typeparam>
 /// <typeparam name="TDbType">The DB type enum to use for parameters.</typeparam>
 /// <typeparam name="TThis">The type of this class in order to facilitate proper expressive notation.</typeparam>
+[System.Diagnostics.CodeAnalysis.SuppressMessage("Style", "IDE0045:Convert to conditional expression", Justification = "<Pending>")]
 public abstract partial class ExpressiveCommandBase<TConnection, TCommand, TReader, TDbType, TThis>
         : IExecuteCommand<TCommand>, IExecuteReader<TReader>
         where TConnection : class, IDbConnection
@@ -156,7 +157,7 @@ protected ExpressiveCommandBase(
     protected TCommand PrepareCommand(TConnection connection)
     {
         var cmd = connection.CreateCommand(Type, Command, Timeout);
-        if (!(cmd is TCommand c))
+        if (cmd is not TCommand c)
             throw new InvalidCastException($"Actual command type ({cmd.GetType()}) is not compatible with expected command type ({typeof(TCommand)}).");
         if (Transaction != null)
             c.Transaction = Transaction;
@@ -226,14 +227,16 @@ public TThis AddParam(string name, object value)
         return (TThis)this;
     }
 
-    /// <summary>
-    /// Adds a parameter to the params list.
-    /// </summary>
-    /// <param name="name">The name of the parameter.</param>
-    /// <param name="value">The value of the parameter.</param>
-    /// <param name="type">The database type of the parameter.</param>
-    /// <returns>This instance for use in method chaining.</returns>
-    public TThis AddParam<T>(string name, T? value, TDbType type)
+
+
+	/// <summary>
+	/// Adds a parameter to the params list.
+	/// </summary>
+	/// <param name="name">The name of the parameter.</param>
+	/// <param name="value">The value of the parameter.</param>
+	/// <param name="type">The database type of the parameter.</param>
+	/// <returns>This instance for use in method chaining.</returns>
+	public TThis AddParam<T>(string name, T? value, TDbType type)
         where T : struct
     {
         if (name is null) throw new ArgumentNullException(nameof(name));

Core/Extensions/Command._.cs

@@ -277,6 +277,7 @@ public static void ExecuteReader(this IDbCommand command, Action<IDataReader> ha
     /// <summary>
     /// Executes a reader on a command with a transform function.
     /// </summary>
+	/// <remarks>The default <see cref="CommandBehavior"/> will open a connection, execute the reader and close the connection it if was not already open.</remarks>
     /// <typeparam name="T">The return type of the transform function.</typeparam>
     /// <param name="command">The IDbCommand to generate a reader from.</param>
     /// <param name="transform">The transform function for each IDataRecord.</param>

Core/Extensions/DataRecord.cs

@@ -325,12 +325,10 @@ public static object[] GetValuesFromOrdinals(this IDataRecord record, IList<int>
     public static IEnumerable<(string Name, int Ordinal)> MatchingOrdinals(this IDataRecord record, IEnumerable<string> columnNames, bool sort = false)
     {
         // Normalize the requested column names to be lowercase.
-        columnNames = columnNames.Select(c =>
-        {
-            if (string.IsNullOrWhiteSpace(c))
-                throw new ArgumentException("Column names cannot be null or whitespace only.");
-            return c.ToUpperInvariant();
-        });
+        columnNames = columnNames.Select(c
+            => string.IsNullOrWhiteSpace(c)
+				? throw new ArgumentException("Column names cannot be null or whitespace only.")
+				: c.ToUpperInvariant());
 
         var actual = record.OrdinalMapping();
         if (sort)
@@ -367,13 +365,19 @@ public static (string Name, int Ordinal)[] GetMatchingOrdinals(this IDataRecord
     /// <returns>The enumerable of data type names.</returns>
     public static IEnumerable<string> DataTypeNames(this IDataRecord record)
     {
-        if (record is null) throw new ArgumentNullException(nameof(record));
-        Contract.EndContractBlock();
-
-        var fieldCount = record.FieldCount;
-        for (var i = 0; i < fieldCount; i++)
-            yield return record.GetDataTypeName(i);
-    }
+		return record is null
+            ? throw new ArgumentNullException(nameof(record))
+            : DataTypeNamesCore(record);
+
+		static IEnumerable<string> DataTypeNamesCore(IDataRecord record)
+		{
+			Contract.EndContractBlock();
+
+			var fieldCount = record.FieldCount;
+			for (var i = 0; i < fieldCount; i++)
+				yield return record.GetDataTypeName(i);
+		}
+	}
 
     /// <summary>
     /// Returns all the data type names for the columns of current result set.