Skip to content

docs(flaky-tests): clarify that monitor detection type is editable after creation#664

Draft
samgutentag wants to merge 1 commit into
mainfrom
sam-gutentag/monitor-classification-type-editable
Draft

docs(flaky-tests): clarify that monitor detection type is editable after creation#664
samgutentag wants to merge 1 commit into
mainfrom
sam-gutentag/monitor-classification-type-editable

Conversation

@samgutentag
Copy link
Copy Markdown
Member

Summary

  • Clarifies that both the action type (Classify / Apply labels) and the detection type (Flaky or Broken) can be changed after a monitor is created
  • Adds a note that tests actively flagged by the monitor are re-evaluated immediately when the detection type is updated
  • Applies to Failure Count Monitor and Failure Rate Monitor docs

Source

Test plan

  • Preview in GitBook

Generated by Claude Code

…ter creation

Classification type (Flaky or Broken) can now be changed after a monitor
is created. Previously the docs implied only the action type could be
switched; this makes clear that both fields are editable and that
in-flight detections are re-evaluated immediately on save.

trunk2 PR: https://github.com/trunk-io/trunk2/pull/3951

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
@trunk-staging-io
Copy link
Copy Markdown

Merging to main in this repository is managed by Trunk.

  • To merge this pull request, check the box to the left or comment /trunk merge below.

After your PR is submitted to the merge queue, this comment will be automatically updated with its status. If the PR fails, failure details will also be posted here

@claude
Copy link
Copy Markdown
Contributor

claude Bot commented May 15, 2026

Claude finished @samgutentag's task in 52s —— View job


Claude PR Review

  • Read PR diff
  • Read full context of changed sections
  • Review for typos, grammar, formatting
  • Check documentation best practices

Summary

Clean, focused clarification. The change correctly adds two pieces of information consistently across both monitor docs:

  1. Detection type (Flaky/Broken) is editable after creation, not just action type
  2. Active detections are re-evaluated immediately when detection type is switched

No typos, grammar issues, or formatting problems. Wording is identical in both files — good consistency.

Observations (non-blocking)

1. Scope placementflaky-tests/detection/failure-count-monitor.md:82 and failure-rate-monitor.md:153

The new sentence mentions "detection type" under the ### Action heading, but detection type is technically a sub-attribute of the #### Classify test status action (it doesn't apply when Apply labels is selected). This is a minor scope mismatch, but I think placing it here is the right call — users editing a monitor will likely scan this section first, and grouping "what can be changed after creation" in one place is more useful than scattering the note. Worth keeping as-is.

2. Sentence length — same lines

The second sentence (~25 words) is on the longer side. Optional tightening:

If the monitor is active on any tests when you switch the detection type, those tests are re-evaluated immediately with the new classification.

Switching the detection type immediately re-evaluates any tests the monitor is currently active on.

The current wording is fine; this is purely a style preference.

3. Term consistencyaction type vs Action

The doc uses action type (lowercase) in the new sentence and Action (capitalized) as the section heading. This matches existing usage of detection type (lowercase in prose, see line 86/157), so it's internally consistent. No change needed.

Verdict

No blocking issues. Ready to merge once previewed in GitBook as the test plan notes.


• Branch: sam-gutentag/monitor-classification-type-editable

Copy link
Copy Markdown

@github-actions github-actions Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Auto-approved: Claude code review passed.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Development

Successfully merging this pull request may close these issues.

2 participants