Skip to content

docs: update all docs to reflect current function signatures#58

Merged
ionux merged 1 commit intomainfrom
claude/update-docs-functions-nT1w0
Mar 17, 2026
Merged

docs: update all docs to reflect current function signatures#58
ionux merged 1 commit intomainfrom
claude/update-docs-functions-nT1w0

Conversation

@ionux
Copy link
Copy Markdown
Owner

@ionux ionux commented Mar 17, 2026

After PR #57 added explicit length parameters to all string/key inputs, the docs still showed the old 2/3-param signatures. Update README, wiki API Reference, Usage Guide, and Project Overview to reflect:

  • okj_init() now takes a third argument: uint16_t json_len
  • All key-based getters now take uint16_t key_len between key and out-param
  • Fix wiki/API-Reference.md: OkJsonParser struct missing json_len field
  • Fix wiki/API-Reference.md: all limits are #define macros (not const uint16_t)
  • Fix wiki/Project-Overview.md: example used old pointer-return style for getters
  • Update README limits note: all limits are preprocessor macros

https://claude.ai/code/session_01KbVdde9hta9X9Qy43Si2j1

After PR #57 added explicit length parameters to all string/key inputs,
the docs still showed the old 2/3-param signatures. Update README, wiki
API Reference, Usage Guide, and Project Overview to reflect:

- okj_init() now takes a third argument: uint16_t json_len
- All key-based getters now take uint16_t key_len between key and out-param
- Fix wiki/API-Reference.md: OkJsonParser struct missing json_len field
- Fix wiki/API-Reference.md: all limits are #define macros (not const uint16_t)
- Fix wiki/Project-Overview.md: example used old pointer-return style for getters
- Update README limits note: all limits are preprocessor macros

https://claude.ai/code/session_01KbVdde9hta9X9Qy43Si2j1
@ionux ionux merged commit b062cfa into main Mar 17, 2026
2 checks passed
@ionux ionux deleted the claude/update-docs-functions-nT1w0 branch March 17, 2026 19:04
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.

2 participants