Skip to content
/ docs Public

Document pre-compare transforms for tenzir-test#179

Draft
mavam wants to merge 1 commit intomainfrom
document-pre-compare-transforms
Draft

Document pre-compare transforms for tenzir-test#179
mavam wants to merge 1 commit intomainfrom
document-pre-compare-transforms

Conversation

@mavam
Copy link
Member

@mavam mavam commented Jan 30, 2026

Summary

  • Add pre-compare to the configuration options table in the test framework reference
  • Add a dedicated Pre-compare transforms section with workflow explanation, examples, and use cases
  • Add shell script example showing comment-based configuration
  • Add cross-reference from the Baselines and artifacts section
  • Add Handle non-deterministic output section in the write-tests guide

The pre-compare feature allows normalizing test output before comparison with baselines, which helps handle tests with non-deterministic output from hash-based aggregations, parallel operations, or filesystem enumeration.

Related PRs

Test plan

  • Verify the reference documentation renders correctly
  • Verify internal links work (pre-compare transforms anchor)
  • Check that the guide section follows the existing style

Generated with Claude Code

Add comprehensive documentation for the pre-compare feature that normalizes
test output before baseline comparison. This helps handle tests with
non-deterministic output from hash-based aggregations or parallel operations.

Changes:
- Add pre-compare to the configuration options table in reference docs
- Add detailed Pre-compare transforms section explaining the workflow
- Add shell script example showing comment-based configuration
- Add cross-reference from Baselines section
- Add Handle non-deterministic output section in write-tests guide

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
@github-actions github-actions bot added guide How-to guides reference Reference documentation labels Jan 30, 2026
@github-actions
Copy link
Contributor

📦 Preview  ·  View →  ·  🟢 Live

Auto-updates on push

@mavam mavam marked this pull request as draft January 31, 2026 15:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

guide How-to guides reference Reference documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant