Skip to content

Update wiki docs to match recent README and CI changes#72

Merged
ionux merged 1 commit into
mainfrom
claude/update-wiki-docs-YKAoh
Apr 17, 2026
Merged

Update wiki docs to match recent README and CI changes#72
ionux merged 1 commit into
mainfrom
claude/update-wiki-docs-YKAoh

Conversation

@ionux

@ionux ionux commented Apr 17, 2026

Copy link
Copy Markdown
Owner
  • API-Reference.md: align error code descriptions with README (BAD_NUMBER, BAD_OBJECT, BAD_STRING, BAD_ARRAY, BAD_BOOLEAN now reflect getter semantics; tighten wording on BAD_POINTER, MAX_TOKENS_EXCEEDED, MAX_STR_LEN_EXCEEDED, MAX_JSON_LEN_EXCEEDED, BRACKET_MISMATCH, INVALID_TYPE_ENUM, NO_FREE_SPACE)
  • Development-and-Testing.md: correct fuzz CI run time from 10 to 30 seconds; add formal-verification Frama-C WP CI job description

https://claude.ai/code/session_01RKgZFo53KSSstKZ56yUbAm

- API-Reference.md: align error code descriptions with README (BAD_NUMBER,
  BAD_OBJECT, BAD_STRING, BAD_ARRAY, BAD_BOOLEAN now reflect getter semantics;
  tighten wording on BAD_POINTER, MAX_TOKENS_EXCEEDED, MAX_STR_LEN_EXCEEDED,
  MAX_JSON_LEN_EXCEEDED, BRACKET_MISMATCH, INVALID_TYPE_ENUM, NO_FREE_SPACE)
- Development-and-Testing.md: correct fuzz CI run time from 10 to 30 seconds;
  add formal-verification Frama-C WP CI job description

https://claude.ai/code/session_01RKgZFo53KSSstKZ56yUbAm

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: dc471942cc

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

Comment thread wiki/API-Reference.md
Comment on lines +75 to +79
| `OKJ_ERROR_BAD_NUMBER` | 8 | Key not found or value is not a number |
| `OKJ_ERROR_BAD_OBJECT` | 9 | Key not found, value is not an object, or member count exceeds `OKJ_MAX_OBJECT_SIZE` |
| `OKJ_ERROR_BAD_STRING` | 10 | Key not found or value is not a string |
| `OKJ_ERROR_BAD_ARRAY` | 11 | Key not found, value is not an array, or element count exceeds `OKJ_MAX_ARRAY_SIZE` |
| `OKJ_ERROR_BAD_BOOLEAN` | 12 | Key not found or value is not a boolean |

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

P2 Badge Document overloaded BAD_ parse meanings*

The shared OkjError table now defines OKJ_ERROR_BAD_NUMBER, OKJ_ERROR_BAD_STRING, and OKJ_ERROR_BAD_BOOLEAN only in getter terms, but okj_parse also returns those codes for malformed literals (as your own parse return table below states). This makes the API reference internally contradictory and can cause callers to mis-handle parser failures as key/type lookup errors; please include both parse and getter semantics (or separate parse/getter meanings) for these overloaded error codes.

Useful? React with 👍 / 👎.

@ionux ionux merged commit d2dadba into main Apr 17, 2026
6 checks passed
@ionux ionux deleted the claude/update-wiki-docs-YKAoh branch April 17, 2026 01:55
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