-
-
Notifications
You must be signed in to change notification settings - Fork 385
Docs: API reference documents unsupported read_csv mode="lax" #2396
Copy link
Copy link
Labels
area:csv-parserCSV reading, scanning, parsing, delimiters, encodings, row handlingCSV reading, scanning, parsing, delimiters, encodings, row handlingarea:docsREADME, docs, examples, contributor docsREADME, docs, examples, contributor docsarea:websiteProject website and web documentationProject website and web documentationdifficulty:beginnerGood for new contributors with limited project contextGood for new contributors with limited project contextgssocPart of the GSSoC 2026 contributor programPart of the GSSoC 2026 contributor programgssoc:level-1GSSoC beginner-level taskGSSoC beginner-level tasklevel:beginnerGSSoC scoring label for beginner-level merged PRsGSSoC scoring label for beginner-level merged PRspriority:mediumUseful and planned, but not urgentUseful and planned, but not urgentsize:xsTiny change; often docs, tests, validation, or one small fixTiny change; often docs, tests, validation, or one small fixstatus:needs-triageNeeds maintainer review for scope, labels, priority, or validityNeeds maintainer review for scope, labels, priority, or validitytype:docsGSSoC-compatible docs labelGSSoC-compatible docs label
Description
Activity
Metadata
Metadata
Assignees
Labels
area:csv-parserCSV reading, scanning, parsing, delimiters, encodings, row handlingCSV reading, scanning, parsing, delimiters, encodings, row handlingarea:docsREADME, docs, examples, contributor docsREADME, docs, examples, contributor docsarea:websiteProject website and web documentationProject website and web documentationdifficulty:beginnerGood for new contributors with limited project contextGood for new contributors with limited project contextgssocPart of the GSSoC 2026 contributor programPart of the GSSoC 2026 contributor programgssoc:level-1GSSoC beginner-level taskGSSoC beginner-level tasklevel:beginnerGSSoC scoring label for beginner-level merged PRsGSSoC scoring label for beginner-level merged PRspriority:mediumUseful and planned, but not urgentUseful and planned, but not urgentsize:xsTiny change; often docs, tests, validation, or one small fixTiny change; often docs, tests, validation, or one small fixstatus:needs-triageNeeds maintainer review for scope, labels, priority, or validityNeeds maintainer review for scope, labels, priority, or validitytype:docsGSSoC-compatible docs labelGSSoC-compatible docs label
Environment / Context
https://arniolib.vercel.app/api.htmldb905172arnio==1.19.0Problem
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.mdusesmode="permissive".docs/chunked_workflows.mddocumentsmodeas"strict"or"permissive".arnio/io.pyvalidatesmode in {"strict", "permissive"}.ar.read_csv(path, mode="lax")raisesValueError: mode must be either 'strict' or 'permissive'.Steps to Reproduce
https://arniolib.vercel.app/api.html.read_csv(...)API entry.modedescription.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
modecontrols 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.htmlSuggested Next Action
Replace
"lax"with"permissive"in the API reference and add/update a website docs test that asserts the documentedmodevalues match the runtime contract.