Repository navigation
v1.4.1 - Comprehensive API Documentation
Comprehensive API Documentation
This release adds complete documentation for all 28 LuaSwift modules.
Added
- Complete API documentation for all modules:
- Standard Library Extensions: stringx, tablex, utf8x, regex, compat
- Data Formats: json, yaml, toml
- Math Namespace: linalg, complex, geo, special, stats, distributions, optimize, integrate, interpolate, cluster, spatial, regress, series, eval, constants, numtheory
- Visualization: plot
- File and Network: iox, http
- docs/ folder with full API reference and usage guides
- Documentation badge in README header
Changed
- README restructured with documentation link prominently placed before examples
- All module docs now use "Function Reference at top" pattern with anchor links for easy navigation
- "External Access" renamed to "File and Network Access" for clarity
- Clarified that iox operates within the sandbox (configurable allowed directories)
- Replaced Python-style variable names (np, plt) with descriptive names (arr, plot)
Documentation Structure
Each module doc now follows an API reference pattern:
- Function Reference table at top with anchor links
- Type mappings and quick reference
- Individual function sections with signatures and examples
- Complex examples at the end
Full Changelog: v1.4.0...v1.4.1