Skip to content

Fix critical documentation errors#398

Merged
PJK merged 1 commit intomasterfrom
fix-doc-critical
Feb 8, 2026
Merged

Fix critical documentation errors#398
PJK merged 1 commit intomasterfrom
fix-doc-critical

Conversation

@PJK
Copy link
Owner

@PJK PJK commented Feb 8, 2026

Summary

  • Fix swapped Doxygen comments in callbacks.h: definite/indefinite labels were reversed for byte strings, arrays, and maps. Since streaming_decoding.rst auto-generates from these via doxygenstruct, the streaming API docs showed wrong descriptions.
  • Fix CBOR encoding example in byte strings docs: 0xf5 (boolean true) -> 0x5f (indefinite byte string start)
  • Fix CBOR encoding example in arrays docs: 0x9f (indefinite array) described as definite -> 0x98 (definite array, 1B length)
  • Fix missing item argument in cbor_set_uint8 code example (wouldn't compile)
  • Fix "positive integer" -> "negative integer" in Type 1 section (copy-paste error)
  • Fix CMake minimum version: 2.8 -> 3.5 (actual requirement since PR Set cmake_minimum_required to 3.5 #355)
  • Fix swapped cross-references in streaming encoding docs (strings linked to byte strings page and vice versa)

Test plan

  • All 26 tests pass
  • Visual review of all changes

🤖 Generated with Claude Code

- Fix swapped Doxygen comments for definite/indefinite callbacks in
  callbacks.h (affects generated streaming decoding docs)
- Fix incorrect CBOR byte 0xf5 -> 0x5f for indefinite byte string start
- Fix incorrect array example: 0x9f -> 0x98 for definite array
- Fix missing item argument in cbor_set_uint8 code example
- Fix "positive" -> "negative" integer in Type 1 section
- Fix CMake minimum version: 2.8 -> 3.5
- Fix swapped cross-references in streaming encoding docs

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
@PJK PJK merged commit 4813d51 into master Feb 8, 2026
14 of 16 checks passed
@PJK PJK deleted the fix-doc-critical branch February 8, 2026 19:05
@codecov
Copy link

codecov bot commented Feb 8, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 100.00%. Comparing base (55408c6) to head (4e3d565).
⚠️ Report is 1 commits behind head on master.

Additional details and impacted files
@@            Coverage Diff            @@
##            master      #398   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files           20        20           
  Lines         1663      1663           
=========================================
  Hits          1663      1663           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant