HigherOrderCO / Bend

A massively parallel, high-level programming language
https://higherorderco.com
Apache License 2.0
17.48k stars 428 forks source link

Document existing IO functionalities #694

Open kings177 opened 3 months ago

kings177 commented 3 months ago

Bend currently has implemented basic IO operations for Open, Close, Read and Write. This task involves creating a comprehensive documentation for these existing functions.

1. What to document:

  1. Function definition
  2. Brief description
  3. Parameters
  4. Return value
  5. Possible errors
  6. Examples
  7. Notes or additional information

2. Template to folow:

Brief description of what the function does.

Parameters:

Returns:

Raises:

Examples:

# Example usage
result = function_name(arg1, arg2)

Notes:

Any additional information or considerations.

Reference materials:

IO Functions Rust's file system Elixir's file system