Skip to content

Bug: docs/design/notifications.md still describes persisted snooze state after #75 fix #367

Closed

Description

@JoshuaRowePhantom

Summary

The fix for #75 updated the code and JSON schema correctly, but did not update the design document.

What needs to change in docs/design/notifications.md

  1. Line 36 - Remove "Persisted per-tab in the user-computer-profile entity." from the IsSnoozed docstring. Replace with "Snooze state is in-memory only and resets on restart."

  2. Lines 159-160 - Remove the persistence paragraph in the Snooze section:

    "Snooze state is persisted per tab key in the user-computer-profile entity under a snoozed-notification-tabs string array field."

  3. Line 259 - Remove the file checklist entry:

    "JsonSchemas/user-computer-profile.json -- add snoozed-notification-tabs string array field"

  4. Line 264 - In Non-goals Bump actions/checkout from 4 to 7 #1, change "snooze state is persisted" to "snooze state is not persisted" (or rewrite to clarify it resets on restart).

Why

Issue #75 required removing all design-doc references to persisting snooze state, but the commit only modified the schema file and a code comment. The design doc is the authoritative spec and still documents the wrong behaviour.

Activity

  1. JoshuaRowePhantom commented on Jun 30, 2026

    @JoshuaRowePhantom
    OwnerAuthor

    Design

    Root cause: The fix for #75 updated the code and JSON schema to remove persisted snooze state, but left four stale references in \docs/design/notifications.md.

    Approach: Update the design doc only — no code changes needed.

    Files that will change:

    • \docs/design/notifications.md\ — fix four stale references to snooze persistence
  2. JoshuaRowePhantom commented on Jun 30, 2026

    @JoshuaRowePhantom
    OwnerAuthor

    Tests

    This is a documentation-only fix. No tests are needed — there is no code to verify.

  3. JoshuaRowePhantom commented on Jun 30, 2026

    @JoshuaRowePhantom
    OwnerAuthor

    Resolution

    Root cause: The fix for #75 updated code and the JSON schema to remove persisted snooze state, but left four stale references in \docs/design/notifications.md\ describing the old persisted behaviour.

    Changes:

    • \docs/design/notifications.md\ — (1) Updated \IsSnoozed\ doc-comment from 'Persisted per-tab in the user-computer-profile entity.' to 'Snooze state is in-memory only and resets on restart.'; (2) Removed the two-line persistence paragraph from the Snooze section; (3) Removed the \JsonSchemas/user-computer-profile.json\ source-layout entry; (4) Rewrote Non-goals Bump actions/checkout from 4 to 7 #1 to state that both notifications and snooze state are in-memory only and reset on restart.

    Deviations from design: None.

    Commit: a59e63e

    Note: Two pre-existing flaky tests observed during test runs (unrelated to this change): #409, #410.

  4. added a commit that references this issue on Jun 30, 2026
    a59e63e
  5. JoshuaRowePhantom commented on Jun 30, 2026

    @JoshuaRowePhantom
    OwnerAuthor

    Verification passed

    Checked: Commit a59e63e on the \ eatures\ branch, modifying \docs/design/notifications.md.

    Result: All four changes described in the issue are present and correctly implemented:

    1. \IsSnoozed\ doc-comment updated from 'Persisted per-tab in the user-computer-profile entity.' to 'Snooze state is in-memory only and resets on restart.'
    2. Persistence paragraph ('Snooze state is persisted per tab key...') removed from the Snooze section.
    3. \JsonSchemas/user-computer-profile.json\ source-layout entry removed.
    4. Non-goals Bump actions/checkout from 4 to 7 #1 rewritten to state both notifications and snooze state are in-memory only and reset on restart.

    This is a documentation-only fix; no code changes or tests are required.

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

Metadata

Metadata

Assignees

No one assigned

    Labels

    bugSomething isn't workingverifiedIssue has been verified

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions