Skip to content

Commit 40607bc

Browse files
committed
Fixed typo
1 parent 0053717 commit 40607bc

File tree

2 files changed

+15
-15
lines changed

2 files changed

+15
-15
lines changed

src/DotNext/Optional.cs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ public static async Task<T> Flatten<T>(this Task<Optional<T>> task)
5151
/// non-null, return an Optional describing the result. Otherwise, returns <see cref="Optional{T}.None"/>.
5252
/// </summary>
5353
/// <typeparam name="TInput">The type of stored in the Optional container.</typeparam>
54-
/// <typeparam name="TOutput">The type of the result of the mapping function.</typeparam>
54+
/// <typeparam name="TOutput">The type of the mapping function result.</typeparam>
5555
/// <param name="task">The task containing Optional value.</param>
5656
/// <param name="converter">A mapping function to be applied to the value, if present.</param>
5757
/// <returns>An Optional describing the result of applying a mapping function to the value of this Optional, if a value is present, otherwise <see cref="Optional{T}.None"/>.</returns>
@@ -63,7 +63,7 @@ public static async Task<Optional<TOutput>> Convert<TInput, TOutput>(this Task<O
6363
/// non-null, return an Optional describing the result. Otherwise, returns <see cref="Optional{T}.None"/>.
6464
/// </summary>
6565
/// <typeparam name="TInput">The type of stored in the Optional container.</typeparam>
66-
/// <typeparam name="TOutput">The type of the result of the mapping function.</typeparam>
66+
/// <typeparam name="TOutput">The type of the mapping function result.</typeparam>
6767
/// <param name="task">The task containing Optional value.</param>
6868
/// <param name="converter">A mapping function to be applied to the value, if present.</param>
6969
/// <param name="token">The token that can be used to cancel the operation.</param>

src/DotNext/Result.cs

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ public static class Result
4747
public static ref readonly Result<T> Coalesce<T>(this in Result<T> first, in Result<T> second) => ref first.IsSuccessful ? ref first : ref second;
4848

4949
/// <summary>
50-
/// Indicates that specified type is result type.
50+
/// Indicates that the specified type is the result type.
5151
/// </summary>
5252
/// <param name="resultType">The type of <see cref="Result{T}"/>.</param>
5353
/// <returns><see langword="true"/>, if specified type is result type; otherwise, <see langword="false"/>.</returns>
@@ -57,7 +57,7 @@ public static class Result
5757
/// Returns the underlying type argument of the specified result type.
5858
/// </summary>
5959
/// <param name="resultType">Result type.</param>
60-
/// <returns>Underlying type argument of result type; otherwise, <see langword="null"/>.</returns>
60+
/// <returns>Underlying type argument of the result type; otherwise, <see langword="null"/>.</returns>
6161
public static Type? GetUnderlyingType(Type resultType) => IsResult(resultType) ? resultType.GetGenericArguments()[0] : null;
6262

6363
/// <summary>
@@ -78,7 +78,7 @@ public static class Result
7878
}
7979

8080
/// <summary>
81-
/// Represents a result of operation which can be actual result or exception.
81+
/// Represents a result of operation which can be the actual result or exception.
8282
/// </summary>
8383
/// <typeparam name="T">The type of the value stored in the Result monad.</typeparam>
8484
[StructLayout(LayoutKind.Auto)]
@@ -203,28 +203,28 @@ private Result<TResult> Convert<TResult, TConverter>(TConverter converter)
203203
}
204204

205205
/// <summary>
206-
/// If successful result is present, apply the provided mapping function hiding any exception
206+
/// If the successful result is present, apply the provided mapping function hiding any exception
207207
/// caused by the converter.
208208
/// </summary>
209209
/// <param name="converter">A mapping function to be applied to the value, if present.</param>
210-
/// <typeparam name="TResult">The type of the result of the mapping function.</typeparam>
210+
/// <typeparam name="TResult">The type of the mapping function result.</typeparam>
211211
/// <returns>The conversion result.</returns>
212212
public Result<TResult> Convert<TResult>(Converter<T, TResult> converter)
213213
=> Convert<TResult, DelegatingConverter<T, TResult>>(converter);
214214

215215
/// <summary>
216-
/// If successful result is present, apply the provided mapping function hiding any exception
216+
/// If the successful result is present, apply the provided mapping function hiding any exception
217217
/// caused by the converter.
218218
/// </summary>
219219
/// <param name="converter">A mapping function to be applied to the value, if present.</param>
220-
/// <typeparam name="TResult">The type of the result of the mapping function.</typeparam>
220+
/// <typeparam name="TResult">The type of the mapping function result.</typeparam>
221221
/// <returns>The conversion result.</returns>
222222
[CLSCompliant(false)]
223223
public unsafe Result<TResult> Convert<TResult>(delegate*<T, TResult> converter)
224224
=> Convert<TResult, Supplier<T, TResult>>(converter);
225225

226226
/// <summary>
227-
/// Attempts to extract value from container if it is present.
227+
/// Attempts to extract value from the container if it is present.
228228
/// </summary>
229229
/// <param name="value">Extracted value.</param>
230230
/// <returns><see langword="true"/> if value is present; otherwise, <see langword="false"/>.</returns>
@@ -518,7 +518,7 @@ private void Validate()
518518
bool IOptionMonad<T>.HasValue => IsSuccessful;
519519

520520
/// <summary>
521-
/// Attempts to extract value from container if it is present.
521+
/// Attempts to extract value from the container if it is present.
522522
/// </summary>
523523
/// <param name="value">Extracted value.</param>
524524
/// <returns><see langword="true"/> if value is present; otherwise, <see langword="false"/>.</returns>
@@ -547,21 +547,21 @@ private Result<TResult, TError> Convert<TResult, TConverter>(TConverter converte
547547
=> IsSuccessful ? new(converter.Invoke(value)) : new(Error);
548548

549549
/// <summary>
550-
/// If successful result is present, apply the provided mapping function hiding any exception
550+
/// If the successful result is present, apply the provided mapping function hiding any exception
551551
/// caused by the converter.
552552
/// </summary>
553553
/// <param name="converter">A mapping function to be applied to the value, if present.</param>
554-
/// <typeparam name="TResult">The type of the result of the mapping function.</typeparam>
554+
/// <typeparam name="TResult">The type of the mapping function result.</typeparam>
555555
/// <returns>The conversion result.</returns>
556556
public Result<TResult, TError> Convert<TResult>(Converter<T, TResult> converter)
557557
=> Convert<TResult, DelegatingConverter<T, TResult>>(converter);
558558

559559
/// <summary>
560-
/// If successful result is present, apply the provided mapping function hiding any exception
560+
/// If the successful result is present, apply the provided mapping function hiding any exception
561561
/// caused by the converter.
562562
/// </summary>
563563
/// <param name="converter">A mapping function to be applied to the value, if present.</param>
564-
/// <typeparam name="TResult">The type of the result of the mapping function.</typeparam>
564+
/// <typeparam name="TResult">The type of the mapping function result.</typeparam>
565565
/// <returns>The conversion result.</returns>
566566
[CLSCompliant(false)]
567567
public unsafe Result<TResult, TError> Convert<TResult>(delegate*<T, TResult> converter)

0 commit comments

Comments
 (0)