Skip to content

Commit 3e40088

Browse files
Standardize documentation styles for physics quantities and enhance integration tests. This update introduces explicit XML documentation formats for dimension properties and constructors, improving clarity and consistency. Additionally, it refines advanced integration tests to ensure accurate cross-domain calculations, further solidifying the library's robustness for scientific applications.
1 parent da4f0cc commit 3e40088

6 files changed

Lines changed: 1112 additions & 732 deletions

File tree

.cursor/rules/derived-cursor-rules.mdc

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -204,4 +204,6 @@ When adding XML documentation comments:
204204
* **Next Steps**
205205
* The foundation has been established for:
206206
* Completing consistency fixes across all remaining physics quantity files
207-
* Implementing the advanced test suites to establish performance baselines
207+
* Implementing the advanced test suites to establish performance baselines
208+
* **Standardize dimension property documentation styles**. Use explicit documentation like `/// <summary>Gets the physical dimension of [quantity] [SYMBOL].</summary>` instead of `/// <inheritdoc/>`.
209+
* **Standardize constructor documentation styles**. Use `/// <summary>Initializes a new instance of the <see cref="[ClassName]{T}"/> class.</summary>` instead of `/// Initializes a new instance of the [ClassName] class.`

0 commit comments

Comments
 (0)