From 651146c97b3dd7c1bafc95c9ad0062efb75da48f Mon Sep 17 00:00:00 2001
From: Tyrrrz <1935960+Tyrrrz@users.noreply.github.com>
Date: Sun, 11 Aug 2024 22:22:03 +0300
Subject: [PATCH] asd

---
 CliFx/Exceptions/CliFxException.cs                   |  2 +-
 CliFx/Extensibility/BindingConverter.cs              | 12 +++++-------
 CliFx/Extensibility/BindingValidator.cs              |  7 ++-----
 CliFx/Extensibility/BoolBindingConverter.cs          |  6 +++---
 CliFx/Extensibility/ConvertibleBindingConverter.cs   |  6 +++---
 .../Extensibility/DateTimeOffsetBindingConverter.cs  |  6 +++---
 CliFx/Extensibility/DelegateBindingConverter.cs      |  8 ++++----
 CliFx/Extensibility/EnumBindingConverter.cs          |  6 +++---
 CliFx/Extensibility/IBindingConverter.cs             |  2 +-
 CliFx/Extensibility/IBindingValidator.cs             |  6 +++---
 CliFx/Extensibility/NoopBindingConverter.cs          |  2 +-
 CliFx/Extensibility/NullableBindingConverter.cs      |  8 ++++----
 CliFx/Extensibility/TimeSpanBindingConverter.cs      |  6 +++---
 13 files changed, 36 insertions(+), 41 deletions(-)

diff --git a/CliFx/Exceptions/CliFxException.cs b/CliFx/Exceptions/CliFxException.cs
index 206e18f..5924188 100644
--- a/CliFx/Exceptions/CliFxException.cs
+++ b/CliFx/Exceptions/CliFxException.cs
@@ -40,7 +40,7 @@ public partial class CliFxException
         Exception? innerException = null
     ) => new(message, DefaultExitCode, false, innerException);
 
-    // User errors are typically caused by invalid input and they're meant for the end-user,
+    // User errors are typically caused by invalid input and are meant for the end-user,
     // so we want to show help.
     internal static CliFxException UserError(string message, Exception? innerException = null) =>
         new(message, DefaultExitCode, true, innerException);
diff --git a/CliFx/Extensibility/BindingConverter.cs b/CliFx/Extensibility/BindingConverter.cs
index 469934b..51abe3d 100644
--- a/CliFx/Extensibility/BindingConverter.cs
+++ b/CliFx/Extensibility/BindingConverter.cs
@@ -3,15 +3,13 @@
 namespace CliFx.Extensibility;
 
 /// <summary>
-/// Base type for custom converters.
+/// Defines custom conversion logic for activating command inputs from the corresponding raw command-line arguments.
 /// </summary>
 public abstract class BindingConverter<T> : IBindingConverter
 {
-    /// <summary>
-    /// Parses the value from a raw command-line argument.
-    /// </summary>
-    public abstract T? Convert(string? rawValue, IFormatProvider? formatProvider);
+    /// <inheritdoc cref="IBindingConverter.Convert" />
+    public abstract T? Convert(string? rawArgument, IFormatProvider? formatProvider);
 
-    object? IBindingConverter.Convert(string? rawValue, IFormatProvider? formatProvider) =>
-        Convert(rawValue, formatProvider);
+    object? IBindingConverter.Convert(string? rawArgument, IFormatProvider? formatProvider) =>
+        Convert(rawArgument, formatProvider);
 }
diff --git a/CliFx/Extensibility/BindingValidator.cs b/CliFx/Extensibility/BindingValidator.cs
index 5b3e486..50c757f 100644
--- a/CliFx/Extensibility/BindingValidator.cs
+++ b/CliFx/Extensibility/BindingValidator.cs
@@ -1,7 +1,7 @@
 namespace CliFx.Extensibility;
 
 /// <summary>
-/// Base type for custom validators.
+/// Defines custom validation logic for activated command inputs.
 /// </summary>
 public abstract class BindingValidator<T> : IBindingValidator
 {
@@ -15,10 +15,7 @@ public abstract class BindingValidator<T> : IBindingValidator
     /// </summary>
     protected BindingValidationError Error(string message) => new(message);
 
-    /// <summary>
-    /// Validates the value bound to a parameter or an option.
-    /// Returns null if validation is successful, or an error in case of failure.
-    /// </summary>
+    /// <inheritdoc cref="IBindingValidator.Validate" />
     /// <remarks>
     /// You can use the utility methods <see cref="Ok" /> and <see cref="Error" /> to
     /// create an appropriate result.
diff --git a/CliFx/Extensibility/BoolBindingConverter.cs b/CliFx/Extensibility/BoolBindingConverter.cs
index b004638..1f72ca6 100644
--- a/CliFx/Extensibility/BoolBindingConverter.cs
+++ b/CliFx/Extensibility/BoolBindingConverter.cs
@@ -3,11 +3,11 @@
 namespace CliFx.Extensibility;
 
 /// <summary>
-/// Converter for binding inputs to properties of type <see cref="bool" />.
+/// Converter for binding command inputs to properties of type <see cref="bool" />.
 /// </summary>
 public class BoolBindingConverter : BindingConverter<bool>
 {
     /// <inheritdoc />
-    public override bool Convert(string? rawValue, IFormatProvider? formatProvider) =>
-        string.IsNullOrWhiteSpace(rawValue) || bool.Parse(rawValue);
+    public override bool Convert(string? rawArgument, IFormatProvider? formatProvider) =>
+        string.IsNullOrWhiteSpace(rawArgument) || bool.Parse(rawArgument);
 }
diff --git a/CliFx/Extensibility/ConvertibleBindingConverter.cs b/CliFx/Extensibility/ConvertibleBindingConverter.cs
index ae51ffe..0612a45 100644
--- a/CliFx/Extensibility/ConvertibleBindingConverter.cs
+++ b/CliFx/Extensibility/ConvertibleBindingConverter.cs
@@ -3,12 +3,12 @@
 namespace CliFx.Extensibility;
 
 /// <summary>
-/// Converter for binding inputs to properties that implement <see cref="IConvertible" />.
+/// Converter for binding command inputs to properties whose types implement <see cref="IConvertible" />.
 /// </summary>
 public class ConvertibleBindingConverter<T> : BindingConverter<T>
     where T : IConvertible
 {
     /// <inheritdoc />
-    public override T? Convert(string? rawValue, IFormatProvider? formatProvider) =>
-        (T?)System.Convert.ChangeType(rawValue, typeof(T), formatProvider);
+    public override T? Convert(string? rawArgument, IFormatProvider? formatProvider) =>
+        (T?)System.Convert.ChangeType(rawArgument, typeof(T), formatProvider);
 }
diff --git a/CliFx/Extensibility/DateTimeOffsetBindingConverter.cs b/CliFx/Extensibility/DateTimeOffsetBindingConverter.cs
index 35dd428..ec53316 100644
--- a/CliFx/Extensibility/DateTimeOffsetBindingConverter.cs
+++ b/CliFx/Extensibility/DateTimeOffsetBindingConverter.cs
@@ -3,11 +3,11 @@
 namespace CliFx.Extensibility;
 
 /// <summary>
-/// Converter for binding inputs to properties of type <see cref="DateTimeOffset" />.
+/// Converter for binding command inputs to properties of type <see cref="DateTimeOffset" />.
 /// </summary>
 public class DateTimeOffsetBindingConverter : BindingConverter<DateTimeOffset>
 {
     /// <inheritdoc />
-    public override DateTimeOffset Convert(string? rawValue, IFormatProvider? formatProvider) =>
-        DateTimeOffset.Parse(rawValue!, formatProvider);
+    public override DateTimeOffset Convert(string? rawArgument, IFormatProvider? formatProvider) =>
+        DateTimeOffset.Parse(rawArgument!, formatProvider);
 }
diff --git a/CliFx/Extensibility/DelegateBindingConverter.cs b/CliFx/Extensibility/DelegateBindingConverter.cs
index 5292ea9..828c640 100644
--- a/CliFx/Extensibility/DelegateBindingConverter.cs
+++ b/CliFx/Extensibility/DelegateBindingConverter.cs
@@ -3,7 +3,7 @@
 namespace CliFx.Extensibility;
 
 /// <summary>
-/// Converter for binding inputs to properties using a custom delegate.
+/// Converter for binding command inputs to properties using a custom delegate.
 /// </summary>
 public class DelegateBindingConverter<T>(Func<string?, IFormatProvider?, T> convert)
     : BindingConverter<T>
@@ -12,9 +12,9 @@ public class DelegateBindingConverter<T>(Func<string?, IFormatProvider?, T> conv
     /// Initializes an instance of <see cref="DelegateBindingConverter{T}" />
     /// </summary>
     public DelegateBindingConverter(Func<string?, T> convert)
-        : this((rawValue, _) => convert(rawValue)) { }
+        : this((rawArgument, _) => convert(rawArgument)) { }
 
     /// <inheritdoc />
-    public override T Convert(string? rawValue, IFormatProvider? formatProvider) =>
-        convert(rawValue, formatProvider);
+    public override T Convert(string? rawArgument, IFormatProvider? formatProvider) =>
+        convert(rawArgument, formatProvider);
 }
diff --git a/CliFx/Extensibility/EnumBindingConverter.cs b/CliFx/Extensibility/EnumBindingConverter.cs
index f87b002..417c302 100644
--- a/CliFx/Extensibility/EnumBindingConverter.cs
+++ b/CliFx/Extensibility/EnumBindingConverter.cs
@@ -3,12 +3,12 @@
 namespace CliFx.Extensibility;
 
 /// <summary>
-/// Converter for binding inputs to properties of type <see cref="Enum" />.
+/// Converter for binding command inputs to properties of type <see cref="Enum" />.
 /// </summary>
 public class EnumBindingConverter<T> : BindingConverter<T>
     where T : struct, Enum
 {
     /// <inheritdoc />
-    public override T Convert(string? rawValue, IFormatProvider? formatProvider) =>
-        (T)Enum.Parse(typeof(T), rawValue!, true);
+    public override T Convert(string? rawArgument, IFormatProvider? formatProvider) =>
+        (T)Enum.Parse(typeof(T), rawArgument!, true);
 }
diff --git a/CliFx/Extensibility/IBindingConverter.cs b/CliFx/Extensibility/IBindingConverter.cs
index a87c8a3..fa4fbd9 100644
--- a/CliFx/Extensibility/IBindingConverter.cs
+++ b/CliFx/Extensibility/IBindingConverter.cs
@@ -3,7 +3,7 @@
 namespace CliFx.Extensibility;
 
 /// <summary>
-/// Defines a custom conversion for binding command-line arguments to command inputs.
+/// Defines custom conversion logic for activating command inputs from the corresponding raw command-line arguments.
 /// </summary>
 /// <remarks>
 /// To implement your own converter, inherit from <see cref="BindingConverter{T}" /> instead.
diff --git a/CliFx/Extensibility/IBindingValidator.cs b/CliFx/Extensibility/IBindingValidator.cs
index 97cf561..964af1d 100644
--- a/CliFx/Extensibility/IBindingValidator.cs
+++ b/CliFx/Extensibility/IBindingValidator.cs
@@ -1,7 +1,7 @@
 namespace CliFx.Extensibility;
 
 /// <summary>
-/// Defines a custom validation rules for values bound from command-line arguments.
+/// Defines custom validation logic for activated command inputs.
 /// </summary>
 /// <remarks>
 /// To implement your own validator, inherit from <see cref="BindingValidator{T}" /> instead.
@@ -9,8 +9,8 @@
 public interface IBindingValidator
 {
     /// <summary>
-    /// Validates the value bound to a parameter or an option.
-    /// Returns null if validation is successful, or an error in case of failure.
+    /// Validates the input value.
+    /// Returns <c>null</c> if the validation is successful, or an error in case of failure.
     /// </summary>
     BindingValidationError? Validate(object? value);
 }
diff --git a/CliFx/Extensibility/NoopBindingConverter.cs b/CliFx/Extensibility/NoopBindingConverter.cs
index c977065..92537cd 100644
--- a/CliFx/Extensibility/NoopBindingConverter.cs
+++ b/CliFx/Extensibility/NoopBindingConverter.cs
@@ -3,7 +3,7 @@
 namespace CliFx.Extensibility;
 
 /// <summary>
-/// Converter for binding inputs to properties without any conversion.
+/// Converter for binding command inputs to properties without any conversion.
 /// </summary>
 public class NoopBindingConverter : IBindingConverter
 {
diff --git a/CliFx/Extensibility/NullableBindingConverter.cs b/CliFx/Extensibility/NullableBindingConverter.cs
index be59b98..be3646b 100644
--- a/CliFx/Extensibility/NullableBindingConverter.cs
+++ b/CliFx/Extensibility/NullableBindingConverter.cs
@@ -3,14 +3,14 @@
 namespace CliFx.Extensibility;
 
 /// <summary>
-/// Converter for binding inputs to properties of type <see cref="Nullable{T}" />.
+/// Converter for binding command inputs to properties of type <see cref="Nullable{T}" />.
 /// </summary>
 public class NullableBindingConverter<T>(BindingConverter<T> innerConverter) : BindingConverter<T?>
     where T : struct
 {
     /// <inheritdoc />
-    public override T? Convert(string? rawValue, IFormatProvider? formatProvider) =>
-        !string.IsNullOrWhiteSpace(rawValue)
-            ? innerConverter.Convert(rawValue, formatProvider)
+    public override T? Convert(string? rawArgument, IFormatProvider? formatProvider) =>
+        !string.IsNullOrWhiteSpace(rawArgument)
+            ? innerConverter.Convert(rawArgument, formatProvider)
             : null;
 }
diff --git a/CliFx/Extensibility/TimeSpanBindingConverter.cs b/CliFx/Extensibility/TimeSpanBindingConverter.cs
index 37804d5..0e11016 100644
--- a/CliFx/Extensibility/TimeSpanBindingConverter.cs
+++ b/CliFx/Extensibility/TimeSpanBindingConverter.cs
@@ -3,11 +3,11 @@
 namespace CliFx.Extensibility;
 
 /// <summary>
-/// Converter for binding inputs to properties of type <see cref="TimeSpan" />.
+/// Converter for binding command inputs to properties of type <see cref="TimeSpan" />.
 /// </summary>
 public class TimeSpanBindingConverter : BindingConverter<TimeSpan>
 {
     /// <inheritdoc />
-    public override TimeSpan Convert(string? rawValue, IFormatProvider? formatProvider) =>
-        TimeSpan.Parse(rawValue!, formatProvider);
+    public override TimeSpan Convert(string? rawArgument, IFormatProvider? formatProvider) =>
+        TimeSpan.Parse(rawArgument!, formatProvider);
 }