Alan-Jowett / sonde / 24488676413

82%

push

github

docs(node): clarify WAKE retry count and add map data skip logging (#733)

* docs(node): clarify WAKE retry count and add map data skip logging

F-018: Clarify ND-0700 AC1 from 'retries up to 3 times' to 'sends up
to 4 WAKE frames (1 initial + up to 3 retries)'.

F-019: Add `debug!()` log to `apply_initial_data()` when skipping
map entries with mismatched initial data size (ND-0607 AC4). Aids
field debugging without changing semantics.

F-023: Add naming cross-reference notes to T-N1014 and T-N1015
explaining they validate ND-1006 and ND-1010 respectively, and that
a future renumbering pass may align the IDs.

Closes #698

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Signed-off-by: Alan Jowett <alan.jowett@microsoft.com>

* docs(node): fix AC3 retry wording and naming note collisions

- ND-0700 AC3: 'After 3 failures' → 'After all retries are exhausted'
- T-N1014/T-N1015: explain IDs are not renamed because T-N1006/T-N1010
  are already assigned to other test cases

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Signed-off-by: Alan Jowett <alan.jowett@microsoft.com>

* docs(node): update ND-0607 AC4 to allow debug logging on size mismatch

The `debug!()` log is compiled out in release builds, so the
behavior remains 'silently ignored' in production. Updated the
acceptance criterion to explicitly permit diagnostic logging.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Signed-off-by: Alan Jowett <alan.jowett@microsoft.com>

* docs(node): fix AC4 silent/log contradiction and align ND-0700 description

- ND-0607 AC4: 'silently ignored' → 'ignored without error'; note
  debug log visibility depends on build features (not always compiled out)
- ND-0700 Description: align with AC1 wording ('send up to 4 WAKE
  frames' instead of 'retry up to 3 times')

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Signed-off-by: Alan Jowett <alan.jowett@microsoft.com>

---------

Sig... (continued)

3 of 3 new or added lines in 1 file covered. (100.0%)

23856 of 29692 relevant lines covered (80.34%)

183.86 hits per line