Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document existing IO functionalities #694

Open
kings177 opened this issue Aug 21, 2024 · 0 comments
Open

Document existing IO functionalities #694

kings177 opened this issue Aug 21, 2024 · 0 comments
Labels
documentation Improvements or additions to documentation enhancement New feature or request

Comments

@kings177
Copy link
Member

kings177 commented Aug 21, 2024

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:

  • param1: description of param1
  • param2: description of param2

Returns:

  • description of return value

Raises:

  • ErrorType1: description of when this error occurs
  • ErrorType2: description of when this error occurs

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

@kings177 kings177 added this to the Bend IO lib v0 milestone Aug 21, 2024
@kings177 kings177 added documentation Improvements or additions to documentation enhancement New feature or request labels Aug 22, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant