Skip to content

Docs: API reference documents unsupported read_csv mode="lax" #2396

Description

@im-anishraj

Environment / Context

  • Current website/API reference checked on https://arniolib.vercel.app/api.html
  • Current source/docs checked locally at commit db905172
  • Runtime behavior checked with arnio==1.19.0

Problem

The API reference describes read_csv(..., mode=...) as accepting "strict" or "lax", but Arnio's actual parser contract uses "strict" or "permissive".

Relevant current docs/source signals:

  • README.md uses mode="permissive".
  • docs/chunked_workflows.md documents mode as "strict" or "permissive".
  • arnio/io.py validates mode in {"strict", "permissive"}.
  • Runtime check: ar.read_csv(path, mode="lax") raises ValueError: mode must be either 'strict' or 'permissive'.

Steps to Reproduce

  1. Open https://arniolib.vercel.app/api.html.
  2. Find the read_csv(...) API entry.
  3. Read the mode description.
  4. Try the documented mode="lax" value in Python.

Expected Result

The API page should document the accepted values as "strict" and "permissive".

Actual Result

The API page says mode controls parser strictness with "strict" or "lax", which is not accepted by the API.

Severity / Impact

Medium for documentation correctness. Users following the API reference will receive a validation error for the documented value.

Likely Affected Area

  • website/api.html
  • CSV ingestion docs

Suggested Next Action

Replace "lax" with "permissive" in the API reference and add/update a website docs test that asserts the documented mode values match the runtime contract.

Activity

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

    area:csv-parserCSV reading, scanning, parsing, delimiters, encodings, row handlingarea:docsREADME, docs, examples, contributor docsarea:websiteProject website and web documentationdifficulty:beginnerGood for new contributors with limited project contextgssocPart of the GSSoC 2026 contributor programgssoc:level-1GSSoC beginner-level tasklevel:beginnerGSSoC scoring label for beginner-level merged PRspriority:mediumUseful and planned, but not urgentsize:xsTiny change; often docs, tests, validation, or one small fixstatus:needs-triageNeeds maintainer review for scope, labels, priority, or validitytype:docsGSSoC-compatible docs label

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions