Skip to content

v1.4.1 - Comprehensive API Documentation

Choose a tag to compare

@ChrisGVE ChrisGVE released this 11 Jan 16:42
· 312 commits to main since this release
59ec705

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:

  1. Function Reference table at top with anchor links
  2. Type mappings and quick reference
  3. Individual function sections with signatures and examples
  4. Complex examples at the end

Full Changelog: v1.4.0...v1.4.1