Address PR feedback

Author: Martin Taillefer (from Dev Box)

src/Generators/Microsoft.Gen.Logging/Emission/Emitter.Method.cs

@@ -569,7 +569,7 @@ private string MakeClassificationValue(HashSet<string> classificationTypes)
         {
             if (i > 0)
             {
-                _ = sb.Append(" , ");
+                _ = sb.Append(", ");
             }
 
             _ = sb.Append(_classificationMap[ct]);

src/Libraries/Microsoft.Extensions.Compliance.Abstractions/Classification/DataClassification.cs

@@ -7,7 +7,7 @@
 namespace Microsoft.Extensions.Compliance.Classification;
 
 /// <summary>
-/// Represents a single data class which is part of a data taxonomy.
+/// Represents a single classification which is part of a data taxonomy.
 /// </summary>
 public readonly struct DataClassification : IEquatable<DataClassification>
 {
@@ -27,15 +27,15 @@ namespace Microsoft.Extensions.Compliance.Classification;
     public string TaxonomyName { get; }
 
     /// <summary>
-    /// Gets the value representing the data class within the taxonomy.
+    /// Gets the value representing the classification within the taxonomy.
     /// </summary>
     public string Value { get; }
 
     /// <summary>
     /// Initializes a new instance of the <see cref="DataClassification"/> struct.
     /// </summary>
-    /// <param name="taxonomyName">The name of the taxonomy this classification belongs to.</param>
-    /// <param name="value">The taxonomy-specific value representing the data class.</param>
+    /// <param name="taxonomyName">The name of the data taxonomy this classification belongs to.</param>
+    /// <param name="value">The taxonomy-specific value representing the classification.</param>
     public DataClassification(string taxonomyName, string value)
     {
         TaxonomyName = Throw.IfNullOrEmpty(taxonomyName);
@@ -49,21 +49,21 @@ private DataClassification(string value)
     }
 
     /// <summary>
-    /// Checks if object is equal to this instance of <see cref="DataClassification"/>.
+    /// Checks if an object is equal to this instance of <see cref="DataClassification"/>.
     /// </summary>
     /// <param name="obj">Object to check for equality.</param>
     /// <returns><see langword="true" /> if object instances are equal <see langword="false" /> otherwise.</returns>
     public override bool Equals(object? obj) => (obj is DataClassification dc) && Equals(dc);
 
     /// <summary>
-    /// Checks if object is equal to this instance of <see cref="DataClassification"/>.
+    /// Checks if an object is equal to this instance of <see cref="DataClassification"/>.
     /// </summary>
     /// <param name="other">Instance of <see cref="DataClassification"/> to check for equality.</param>
     /// <returns><see langword="true" /> if object instances are equal <see langword="false" /> otherwise.</returns>
     public bool Equals(DataClassification other) => other.TaxonomyName == TaxonomyName && other.Value == Value;
 
     /// <summary>
-    /// Get the hash code the current instance.
+    /// Get the hash code for the current instance.
     /// </summary>
     /// <returns>Hash code.</returns>
     public override int GetHashCode()
@@ -97,5 +97,5 @@ public override int GetHashCode()
     /// Gets a string representation of this object.
     /// </summary>
     /// <returns>A string representing the object.</returns>
-    public override string ToString() => $"{TaxonomyName}:{Value}";
+    public override string ToString() => string.IsNullOrWhiteSpace(TaxonomyName) ? Value : $"{TaxonomyName}:{Value}";
 }

src/Libraries/Microsoft.Extensions.Compliance.Abstractions/Classification/DataClassificationAttribute.cs

@@ -29,7 +29,7 @@ public class DataClassificationAttribute : Attribute
     public string Notes { get; set; } = string.Empty;
 
     /// <summary>
-    /// Gets the data class represented by this attribute.
+    /// Gets the classification represented by this attribute.
     /// </summary>
     public DataClassification Classification { get; }
 

src/Libraries/Microsoft.Extensions.Compliance.Abstractions/Classification/DataClassificationSet.cs

@@ -10,7 +10,7 @@
 namespace Microsoft.Extensions.Compliance.Classification;
 
 /// <summary>
-/// Represents a set of data classes.
+/// Represents a set of data classifications.
 /// </summary>
 public sealed class DataClassificationSet : IEquatable<DataClassificationSet>
 {
@@ -46,7 +46,7 @@ public DataClassificationSet(params DataClassification[] classifications)
     }
 
     /// <summary>
-    /// Converts a data classification to a data classification set.
+    /// Converts a single classification to a data classification set.
     /// </summary>
     /// <param name="classification">The classification to include in the set.</param>
     public static implicit operator DataClassificationSet(DataClassification classification)
@@ -55,16 +55,19 @@ public static implicit operator DataClassificationSet(DataClassification classif
     }
 
     /// <summary>
-    /// Converts a data classification to a data classification set.
+    /// Converts a single classification to a data classification set.
     /// </summary>
     /// <param name="classification">The classification to include in the set.</param>
     /// <returns>The resulting data classification set.</returns>
     public static DataClassificationSet FromDataClassification(DataClassification classification) => new(classification);
 
     /// <summary>
-    /// Creates a new data classification that combines the current classifications with another set.
+    /// Creates a new data classification set that combines the current classifications with another set.
     /// </summary>
     /// <param name="other">The other set.</param>
+    /// <remarks>
+    /// This method doesn't modify the two input sets, it creates a new set.
+    /// </remarks>
     /// <returns>The resulting set which combines the current instance's classifications and the other ones.</returns>
     public DataClassificationSet Union(DataClassificationSet other)
     {
@@ -83,26 +86,18 @@ public DataClassificationSet Union(DataClassificationSet other)
     public override int GetHashCode() => _classifications.GetHashCode();
 
     /// <summary>
-    /// Compares an object with the current instance to see if they contain the same data classes.
+    /// Compares an object with the current instance to see if they contain the same classifications.
     /// </summary>
     /// <param name="obj">The other data classification to compare to.</param>
     /// <returns><see langword="true"/> if the two sets contain the same classifications.</returns>
     public override bool Equals(object? obj) => Equals(obj as DataClassificationSet);
 
     /// <summary>
-    /// Compares an object with the current instance to see if they contain the same data classes.
+    /// Compares an object with the current instance to see if they contain the same classifications.
     /// </summary>
     /// <param name="other">The other data classification to compare to.</param>
     /// <returns><see langword="true"/> if the two sets contain the same classifications.</returns>
-    public bool Equals(DataClassificationSet? other)
-    {
-        if (other == null)
-        {
-            return false;
-        }
-
-        return _classifications.SetEquals(other._classifications);
-    }
+    public bool Equals(DataClassificationSet? other) => other != null && _classifications.SetEquals(other._classifications);
 
     /// <summary>
     /// Returns a string representation of this object.

test/Libraries/Microsoft.Extensions.Compliance.Abstractions.Tests/Classification/DataClassificationTests.cs

@@ -45,5 +45,8 @@ public static void ToStringOutput()
         var dc = new DataClassification(TaxonomyName, Value);
 
         Assert.Equal($"{TaxonomyName}:{Value}", dc.ToString());
+
+        Assert.Equal("None", DataClassification.None.ToString());
+        Assert.Equal("Unknown", DataClassification.Unknown.ToString());
     }
 }