Skip to content

Commit

Permalink
Fix typos in DynamicData summary comments (#287)
Browse files Browse the repository at this point in the history
  • Loading branch information
lxia1220 authored and glennawatson committed Oct 5, 2019
1 parent 4de0036 commit 9100e5c
Show file tree
Hide file tree
Showing 15 changed files with 45 additions and 45 deletions.
50 changes: 25 additions & 25 deletions src/DynamicData/Aggregation/AvgEx.cs
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ public static class AvgEx
/// <param name="valueSelector">The function which returns the value</param>
/// <param name="emptyValue">The resulting average value when there is no data</param>
/// <returns>
/// An obervable of averages
/// An observable of averages
/// </returns>
public static IObservable<double> Avg<TObject, TKey>([NotNull] this IObservable<IChangeSet<TObject, TKey>> source, [NotNull] Func<TObject, int> valueSelector, int emptyValue = 0)
{
Expand All @@ -41,7 +41,7 @@ public static IObservable<double> Avg<TObject, TKey>([NotNull] this IObservable<
/// <param name="valueSelector">The function which returns the value</param>
/// <param name="emptyValue">The resulting average value when there is no data</param>
/// <returns>
/// An obervable of averages
/// An observable of averages
/// </returns>
public static IObservable<double> Avg<TObject, TKey>([NotNull] this IObservable<IChangeSet<TObject, TKey>> source, [NotNull] Func<TObject, int?> valueSelector, int emptyValue = 0)
{
Expand All @@ -57,7 +57,7 @@ public static IObservable<double> Avg<TObject, TKey>([NotNull] this IObservable<
/// <param name="valueSelector">The function which returns the value</param>
/// <param name="emptyValue">The resulting average value when there is no data</param>
/// <returns>
/// An obervable of averages
/// An observable of averages
/// </returns>
public static IObservable<double> Avg<TObject, TKey>([NotNull] this IObservable<IChangeSet<TObject, TKey>> source,
[NotNull] Func<TObject, long> valueSelector, long emptyValue = 0)
Expand All @@ -74,7 +74,7 @@ public static IObservable<double> Avg<TObject, TKey>([NotNull] this IObservable<
/// <param name="valueSelector">The function which returns the value</param>
/// <param name="emptyValue">The resulting average value when there is no data</param>
/// <returns>
/// An obervable of averages
/// An observable of averages
/// </returns>
public static IObservable<double> Avg<TObject, TKey>([NotNull] this IObservable<IChangeSet<TObject, TKey>> source, [NotNull] Func<TObject, long?> valueSelector, long emptyValue = 0)
{
Expand All @@ -90,7 +90,7 @@ public static IObservable<double> Avg<TObject, TKey>([NotNull] this IObservable<
/// <param name="valueSelector">The function which returns the value</param>
/// <param name="emptyValue">The resulting average value when there is no data</param>
/// <returns>
/// An obervable of averages
/// An observable of averages
/// </returns>
public static IObservable<double> Avg<TObject, TKey>([NotNull] this IObservable<IChangeSet<TObject, TKey>> source,
[NotNull] Func<TObject, double> valueSelector, double emptyValue = 0)
Expand All @@ -107,7 +107,7 @@ public static IObservable<double> Avg<TObject, TKey>([NotNull] this IObservable<
/// <param name="valueSelector">The function which returns the value</param>
/// <param name="emptyValue">The resulting average value when there is no data</param>
/// <returns>
/// An obervable of averages
/// An observable of averages
/// </returns>
public static IObservable<double> Avg<TObject, TKey>([NotNull] this IObservable<IChangeSet<TObject, TKey>> source, [NotNull] Func<TObject, double?> valueSelector, double emptyValue = 0)
{
Expand All @@ -123,7 +123,7 @@ public static IObservable<double> Avg<TObject, TKey>([NotNull] this IObservable<
/// <param name="valueSelector">The function which returns the value</param>
/// <param name="emptyValue">The resulting average value when there is no data</param>
/// <returns>
/// An obervable of averages
/// An observable of averages
/// </returns>
public static IObservable<decimal> Avg<TObject, TKey>([NotNull] this IObservable<IChangeSet<TObject, TKey>> source,
[NotNull] Func<TObject, decimal> valueSelector, decimal emptyValue = 0)
Expand All @@ -140,7 +140,7 @@ public static IObservable<decimal> Avg<TObject, TKey>([NotNull] this IObservable
/// <param name="valueSelector">The function which returns the value</param>
/// <param name="emptyValue">The resulting average value when there is no data</param>
/// <returns>
/// An obervable of averages
/// An observable of averages
/// </returns>
public static IObservable<decimal> Avg<TObject, TKey>([NotNull] this IObservable<IChangeSet<TObject, TKey>> source, [NotNull] Func<TObject, decimal?> valueSelector, decimal emptyValue = 0)
{
Expand All @@ -156,7 +156,7 @@ public static IObservable<decimal> Avg<TObject, TKey>([NotNull] this IObservable
/// <param name="valueSelector">The function which returns the value</param>
/// <param name="emptyValue">The resulting average value when there is no data</param>
/// <returns>
/// An obervable of averages
/// An observable of averages
/// </returns>
public static IObservable<float> Avg<TObject, TKey>([NotNull] this IObservable<IChangeSet<TObject, TKey>> source,
[NotNull] Func<TObject, float> valueSelector, float emptyValue = 0)
Expand All @@ -173,7 +173,7 @@ public static IObservable<float> Avg<TObject, TKey>([NotNull] this IObservable<I
/// <param name="valueSelector">The function which returns the value</param>
/// <param name="emptyValue">The resulting average value when there is no data</param>
/// <returns>
/// An obervable of averages
/// An observable of averages
/// </returns>
public static IObservable<float> Avg<TObject, TKey>([NotNull] this IObservable<IChangeSet<TObject, TKey>> source, [NotNull] Func<TObject, float?> valueSelector, float emptyValue = 0)
{
Expand All @@ -192,7 +192,7 @@ public static IObservable<float> Avg<TObject, TKey>([NotNull] this IObservable<I
/// <param name="valueSelector">The function which returns the value</param>
/// <param name="emptyValue">The resulting average value when there is no data</param>
/// <returns>
/// An obervable of averages
/// An observable of averages
/// </returns>
public static IObservable<double> Avg<T>([NotNull] this IObservable<IChangeSet<T>> source,
[NotNull] Func<T, int> valueSelector, int emptyValue = 0)
Expand All @@ -208,7 +208,7 @@ public static IObservable<double> Avg<T>([NotNull] this IObservable<IChangeSet<T
/// <param name="valueSelector">The function which returns the value</param>
/// <param name="emptyValue">The resulting average value when there is no data</param>
/// <returns>
/// An obervable of averages
/// An observable of averages
/// </returns>
public static IObservable<double> Avg<T>([NotNull] this IObservable<IChangeSet<T>> source, [NotNull] Func<T, int?> valueSelector, int emptyValue = 0)
{
Expand All @@ -223,7 +223,7 @@ public static IObservable<double> Avg<T>([NotNull] this IObservable<IChangeSet<T
/// <param name="valueSelector">The function which returns the value</param>
/// <param name="emptyValue">The resulting average value when there is no data</param>
/// <returns>
/// An obervable of averages
/// An observable of averages
/// </returns>
public static IObservable<double> Avg<T>([NotNull] this IObservable<IChangeSet<T>> source, [NotNull] Func<T, long> valueSelector, long emptyValue = 0)
{
Expand All @@ -238,7 +238,7 @@ public static IObservable<double> Avg<T>([NotNull] this IObservable<IChangeSet<T
/// <param name="valueSelector">The function which returns the value</param>
/// <param name="emptyValue">The resulting average value when there is no data</param>
/// <returns>
/// An obervable of averages
/// An observable of averages
/// </returns>
public static IObservable<double> Avg<T>([NotNull] this IObservable<IChangeSet<T>> source, [NotNull] Func<T, long?> valueSelector, long emptyValue = 0)
{
Expand All @@ -253,7 +253,7 @@ public static IObservable<double> Avg<T>([NotNull] this IObservable<IChangeSet<T
/// <param name="valueSelector">The function which returns the value</param>
/// <param name="emptyValue">The resulting average value when there is no data</param>
/// <returns>
/// An obervable of averages
/// An observable of averages
/// </returns>
public static IObservable<double> Avg<T>([NotNull] this IObservable<IChangeSet<T>> source,
[NotNull] Func<T, double> valueSelector, double emptyValue = 0)
Expand All @@ -269,7 +269,7 @@ public static IObservable<double> Avg<T>([NotNull] this IObservable<IChangeSet<T
/// <param name="valueSelector">The function which returns the value</param>
/// <param name="emptyValue">The resulting average value when there is no data</param>
/// <returns>
/// An obervable of averages
/// An observable of averages
/// </returns>
public static IObservable<double> Avg<T>([NotNull] this IObservable<IChangeSet<T>> source, [NotNull] Func<T, double?> valueSelector, double emptyValue = 0)
{
Expand All @@ -284,7 +284,7 @@ public static IObservable<double> Avg<T>([NotNull] this IObservable<IChangeSet<T
/// <param name="valueSelector">The function which returns the value</param>
/// <param name="emptyValue">The resulting average value when there is no data</param>
/// <returns>
/// An obervable of averages
/// An observable of averages
/// </returns>
public static IObservable<decimal> Avg<T>([NotNull] this IObservable<IChangeSet<T>> source,
[NotNull] Func<T, decimal> valueSelector, decimal emptyValue = 0)
Expand All @@ -300,7 +300,7 @@ public static IObservable<decimal> Avg<T>([NotNull] this IObservable<IChangeSet<
/// <param name="valueSelector">The function which returns the value</param>
/// <param name="emptyValue">The resulting average value when there is no data</param>
/// <returns>
/// An obervable of averages
/// An observable of averages
/// </returns>
public static IObservable<decimal> Avg<T>([NotNull] this IObservable<IChangeSet<T>> source, [NotNull] Func<T, decimal?> valueSelector, decimal emptyValue = 0)
{
Expand All @@ -315,7 +315,7 @@ public static IObservable<decimal> Avg<T>([NotNull] this IObservable<IChangeSet<
/// <param name="valueSelector">The function which returns the value</param>
/// <param name="emptyValue">The resulting average value when there is no data</param>
/// <returns>
/// An obervable of averages
/// An observable of averages
/// </returns>
public static IObservable<float> Avg<T>([NotNull] this IObservable<IChangeSet<T>> source,
[NotNull] Func<T, float> valueSelector, float emptyValue = 0)
Expand All @@ -331,7 +331,7 @@ public static IObservable<float> Avg<T>([NotNull] this IObservable<IChangeSet<T>
/// <param name="valueSelector">The function which returns the value</param>
/// <param name="emptyValue">The resulting average value when there is no data</param>
/// <returns>
/// An obervable of averages
/// An observable of averages
/// </returns>
public static IObservable<float> Avg<T>([NotNull] this IObservable<IChangeSet<T>> source, [NotNull] Func<T, float?> valueSelector, float emptyValue = 0)
{
Expand All @@ -350,7 +350,7 @@ public static IObservable<float> Avg<T>([NotNull] this IObservable<IChangeSet<T>
/// <param name="valueSelector">The function which returns the value</param>
/// <param name="emptyValue">The resulting average value when there is no data</param>
/// <returns>
/// An obervable of averages
/// An observable of averages
/// </returns>
public static IObservable<double> Avg<T>([NotNull] this IObservable<IAggregateChangeSet<T>> source,
[NotNull] Func<T, int> valueSelector, int emptyValue = 0)
Expand All @@ -370,7 +370,7 @@ public static IObservable<double> Avg<T>([NotNull] this IObservable<IAggregateCh
/// <param name="valueSelector">The function which returns the value</param>
/// <param name="emptyValue">The resulting average value when there is no data</param>
/// <returns>
/// An obervable of averages
/// An observable of averages
/// </returns>
public static IObservable<double> Avg<T>([NotNull] this IObservable<IAggregateChangeSet<T>> source, [NotNull] Func<T, int?> valueSelector, int emptyValue = 0)
{
Expand Down Expand Up @@ -402,7 +402,7 @@ public static IObservable<double> Avg<T>([NotNull] this IObservable<IAggregateCh
/// <param name="valueSelector">The function which returns the value</param>
/// <param name="emptyValue">The resulting average value when there is no data</param>
/// <returns>
/// An obervable of averages
/// An observable of averages
/// </returns>
public static IObservable<double> Avg<T>([NotNull] this IObservable<IAggregateChangeSet<T>> source, [NotNull] Func<T, long?> valueSelector, long emptyValue = 0)
{
Expand All @@ -417,7 +417,7 @@ public static IObservable<double> Avg<T>([NotNull] this IObservable<IAggregateCh
/// <param name="valueSelector">The function which returns the value</param>
/// <param name="emptyValue">The resulting average value when there is no data</param>
/// <returns>
/// An obervable of averages
/// An observable of averages
/// </returns>
public static IObservable<double> Avg<T>([NotNull] this IObservable<IAggregateChangeSet<T>> source,
[NotNull] Func<T, double> valueSelector, double emptyValue = 0)
Expand Down Expand Up @@ -452,7 +452,7 @@ public static IObservable<double> Avg<T>([NotNull] this IObservable<IAggregateCh
/// <param name="valueSelector">The function which returns the value</param>
/// <param name="emptyValue">The resulting average value when there is no data</param>
/// <returns>
/// An obervable of averages
/// An observable of averages
/// </returns>
public static IObservable<decimal> Avg<T>([NotNull] this IObservable<IAggregateChangeSet<T>> source,
[NotNull] Func<T, decimal> valueSelector, decimal emptyValue = 0)
Expand Down
8 changes: 4 additions & 4 deletions src/DynamicData/Aggregation/MaxEx.cs
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ public static class MaxEx
#region Abstracted

/// <summary>
/// Continually calculates the maximum value from the underlying data sourcce
/// Continually calculates the maximum value from the underlying data source
/// </summary>
/// <typeparam name="TObject">The type of the object.</typeparam>
/// <typeparam name="TResult">The type of the result.</typeparam>
Expand All @@ -38,7 +38,7 @@ public static IObservable<TResult> Maximum<TObject, TResult>([NotNull] this IObs
}

/// <summary>
/// Continually calculates the maximum value from the underlying data sourcce
/// Continually calculates the maximum value from the underlying data source
/// </summary>
/// <typeparam name="TObject">The type of the object.</typeparam>
/// <typeparam name="TKey">The type of the key.</typeparam>
Expand All @@ -56,7 +56,7 @@ public static IObservable<TResult> Maximum<TObject, TResult>([NotNull] this IObs
}

/// <summary>
/// Continually calculates the minimum value from the underlying data sourcce
/// Continually calculates the minimum value from the underlying data source
/// </summary>
/// <typeparam name="TObject">The type of the object.</typeparam>
/// <typeparam name="TResult">The type of the result.</typeparam>
Expand All @@ -71,7 +71,7 @@ public static IObservable<TResult> Maximum<TObject, TResult>([NotNull] this IObs
}

/// <summary>
/// Continually calculates the minimum value from the underlying data sourcce
/// Continually calculates the minimum value from the underlying data source
/// </summary>
/// <typeparam name="TObject">The type of the object.</typeparam>
/// <typeparam name="TKey">The type of the key.</typeparam>
Expand Down
2 changes: 1 addition & 1 deletion src/DynamicData/Aggregation/StdDevEx.cs
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
namespace DynamicData.Aggregation
{
/// <summary>
/// Extensons for calculaing standard deviation
/// Extensions for calculating standard deviation
/// </summary>
public static class StdDevEx
{
Expand Down
4 changes: 2 additions & 2 deletions src/DynamicData/Alias/ObservableListAlias.cs
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
// Copyright (c) 2011-2019 Roland Pheasant. All rights reserved.
// Copyright (c) 2011-2019 Roland Pheasant. All rights reserved.
// Roland Pheasant licenses this file to you under the MIT license.
// See the LICENSE file in the project root for full license information.

Expand Down Expand Up @@ -97,7 +97,7 @@ public static IObservable<IChangeSet<TDestination>> Select<TSource, TDestination

/// <summary>
/// Equivalent to a select many transform. To work, the key must individually identify each child.
/// **** Assumes each child can only have one parent - support for children with multiple parents is a work in progresss
/// **** Assumes each child can only have one parent - support for children with multiple parents is a work in progresses
/// </summary>
/// <typeparam name="TDestination">The type of the destination.</typeparam>
/// <typeparam name="TSource">The type of the source.</typeparam>
Expand Down
2 changes: 1 addition & 1 deletion src/DynamicData/Binding/SortExpressionComparer.cs
Original file line number Diff line number Diff line change
Expand Up @@ -100,7 +100,7 @@ public SortExpressionComparer<T> ThenByAscending(Func<T, IComparable> expression
}

/// <summary>
/// Adds an additional desccending sort expression
/// Adds an additional descending sort expression
/// </summary>
/// <param name="expression">The expression.</param>
/// <returns></returns>
Expand Down
2 changes: 1 addition & 1 deletion src/DynamicData/Cache/IObservableCache.cs
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ namespace DynamicData
public interface IConnectableCache<TObject, TKey>
{
/// <summary>
/// Returns an observable of any changes which match the specified key. The sequence starts with the inital item in the cache (if there is one).
/// Returns an observable of any changes which match the specified key. The sequence starts with the initial item in the cache (if there is one).
/// </summary>
/// <param name="key">The key.</param>
IObservable<Change<TObject, TKey>> Watch(TKey key);
Expand Down
2 changes: 1 addition & 1 deletion src/DynamicData/Cache/IPagedChangeSet.cs
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ namespace DynamicData
public interface IPagedChangeSet<TObject, TKey> : ISortedChangeSet<TObject, TKey>
{
/// <summary>
/// The paramaters used to virtualise the stream
/// The parameters used to virtualise the stream
/// </summary>
IPageResponse Response { get; }
}
Expand Down
2 changes: 1 addition & 1 deletion src/DynamicData/Cache/IVirtualChangeSet.cs
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ namespace DynamicData
public interface IVirtualChangeSet<TObject, TKey> : ISortedChangeSet<TObject, TKey>
{
/// <summary>
/// The paramaters used to virtualise the stream
/// The parameters used to virtualise the stream
/// </summary>
IVirtualResponse Response { get; }
}
Expand Down
Loading

0 comments on commit 9100e5c

Please sign in to comment.