-
-
Notifications
You must be signed in to change notification settings - Fork 114
Closed
Labels
documentationImprovements or additions to documentationImprovements or additions to documentationgood first issueGood for newcomersGood for newcomers
Description
Description
Several core public types lack XML documentation:
AbstractExecutableTest.cs (Lines 10-44)
public required string TestId { get; init; } // No summary
public TestMetadata Metadata { get; init; } = null!; // No summary
public required object?[] Arguments { get; init; } // No summaryOther affected files
TUnit.Core/Attributes/BaseTestAttribute.cs— many public properties without docs- Multiple public methods/properties across
TUnit.Assertions AbstractDynamicTest.cs— no docs
IntelliSense shows no helpful information for these types. Some types like AsyncEvent<T> have excellent documentation, showing the standard isn't applied consistently.
Suggested Fix
Add /// <summary> XML documentation blocks to all public members on core types.
Reactions are currently unavailable
Metadata
Metadata
Assignees
Labels
documentationImprovements or additions to documentationImprovements or additions to documentationgood first issueGood for newcomersGood for newcomers