@specific.dev/spectest 0.12.0 → 0.14.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/src/recorder.ts CHANGED
@@ -84,11 +84,13 @@ export interface AssertionEvent extends BaseEvent {
84
84
  /** Failure message produced by the matcher (only when `passed` is false). */
85
85
  error?: string;
86
86
  /**
87
- * Author-supplied label for a raw assertion made via
88
- * `expectRaw(message, …)`. Renders as the assertion's summary
89
- * ("ASSERT <message>") and serves as its diff-alignment key, since a raw
90
- * assertion has no provenance `path`. Absent for provenance-linked
91
- * `expect(...)` assertions.
87
+ * Author-supplied label for the assertion. **Required** for a raw assertion
88
+ * (`expectRaw(value, message)`), where it renders as the summary
89
+ * ("ASSERT <message>") and serves as the diff-alignment key since a raw
90
+ * assertion has no provenance `path`. **Optional** for a provenance-linked
91
+ * `expect(value, message)`, where it leads the summary as a clarifying note
92
+ * alongside the rendered matcher/target. Absent when `expect(...)` was called
93
+ * without a message.
92
94
  */
93
95
  message?: string;
94
96
  /**