Skip to content

Commit a7e012b

Browse files
committed
Update Unit.cs comments
1 parent 4ca5d1e commit a7e012b

File tree

1 file changed

+22
-19
lines changed

1 file changed

+22
-19
lines changed

src/Abstractions/Unit.cs

Lines changed: 22 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,9 @@ namespace Microsoft.DurableTask;
66
/// <summary>
77
/// Represents a <see cref="Void" /> result.
88
/// </summary>
9+
/// <remarks>
10+
/// Modeled after https://learn.microsoft.com/en-us/dotnet/fsharp/language-reference/unit-type.
11+
/// </remarks>
912
public readonly struct Unit : IEquatable<Unit>, IComparable<Unit>
1013
{
1114
#pragma warning disable CA1801 // unused parameters
@@ -24,50 +27,50 @@ namespace Microsoft.DurableTask;
2427
public static Task<Unit> Task { get; } = System.Threading.Tasks.Task.FromResult(RefValue);
2528

2629
/// <summary>
27-
/// Compares two empties for equality. Always true.
30+
/// Compares two units for equality. Always true.
2831
/// </summary>
29-
/// <param name="left">The left empty.</param>
30-
/// <param name="right">The right empty.</param>
32+
/// <param name="left">The left unit.</param>
33+
/// <param name="right">The right unit.</param>
3134
/// <returns>Always true.</returns>
3235
public static bool operator ==(Unit left, Unit right) => true;
3336

3437
/// <summary>
35-
/// Compares two empties for inequality. Always false.
38+
/// Compares two units for inequality. Always false.
3639
/// </summary>
37-
/// <param name="left">The left empty.</param>
38-
/// <param name="right">The right empty.</param>
40+
/// <param name="left">The left unit.</param>
41+
/// <param name="right">The right unit.</param>
3942
/// <returns>Always false.</returns>
4043
public static bool operator !=(Unit left, Unit right) => !true;
4144

4245
/// <summary>
43-
/// Compares two empties. Always false.
46+
/// Compares two units. Always false.
4447
/// </summary>
45-
/// <param name="left">The left empty.</param>
46-
/// <param name="right">The right empty.</param>
48+
/// <param name="left">The left unit.</param>
49+
/// <param name="right">The right unit.</param>
4750
/// <returns>Always false.</returns>
4851
public static bool operator <(Unit left, Unit right) => false;
4952

5053
/// <summary>
51-
/// Compares two empties. Always true.
54+
/// Compares two units. Always true.
5255
/// </summary>
53-
/// <param name="left">The left empty.</param>
54-
/// <param name="right">The right empty.</param>
56+
/// <param name="left">The left unit.</param>
57+
/// <param name="right">The right unit.</param>
5558
/// <returns>Always true.</returns>
5659
public static bool operator <=(Unit left, Unit right) => true;
5760

5861
/// <summary>
59-
/// Compares two empties. Always false.
62+
/// Compares two units. Always false.
6063
/// </summary>
61-
/// <param name="left">The left empty.</param>
62-
/// <param name="right">The right empty.</param>
64+
/// <param name="left">The left unit.</param>
65+
/// <param name="right">The right unit.</param>
6366
/// <returns>Always false.</returns>
6467
public static bool operator >(Unit left, Unit right) => false;
6568

6669
/// <summary>
67-
/// Compares two empties. Always true.
70+
/// Compares two units. Always true.
6871
/// </summary>
69-
/// <param name="left">The left empty.</param>
70-
/// <param name="right">The right empty.</param>
72+
/// <param name="left">The left unit.</param>
73+
/// <param name="right">The right unit.</param>
7174
/// <returns>Always true.</returns>
7275
public static bool operator >=(Unit left, Unit right) => true;
7376

@@ -84,7 +87,7 @@ namespace Microsoft.DurableTask;
8487
public override int GetHashCode() => 0;
8588

8689
/// <inheritdoc />
87-
public override string ToString() => "{}";
90+
public override string ToString() => "()"; // Same as F# Unit string representation.
8891

8992
#pragma warning restore CA1801 // unused parameters
9093
#pragma warning restore IDE0060 // unused parameters

0 commit comments

Comments
 (0)