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

Add/improve documentation about non-blocking IO #535

Closed
yorickpeterse opened this issue May 20, 2023 · 4 comments
Closed

Add/improve documentation about non-blocking IO #535

yorickpeterse opened this issue May 20, 2023 · 4 comments
Assignees
Labels
accepting contributions Issues that are suitable to be worked on by anybody, not just maintainers documentation Documentation related changes
Milestone

Comments

@yorickpeterse
Copy link
Collaborator

The documentation doesn't clearly describe what Inko does with (non)blocking IO. There's a brief overview in the internals section, but that's not the first place people would look. We should add a page in the "Getting started" section that covers this in greater detail, along with some examples on how to use files and sockets.

@yorickpeterse yorickpeterse added the documentation Documentation related changes label May 20, 2023
@yorickpeterse yorickpeterse modified the milestones: 0.12.0, 0.13.0 May 20, 2023
@yorickpeterse yorickpeterse added the accepting contributions Issues that are suitable to be worked on by anybody, not just maintainers label May 26, 2023
@itsajay1029
Copy link

I'd love to work on this @yorickpeterse Pls assign it to me

@yorickpeterse
Copy link
Collaborator Author

@itsajay1029 Have you taken a look at how Inko handles this/how familiar are you with this part of Inko? The documentation wouldn't just consist of moving the chunk from the internals page to a separate one, but also a more in depth explanation, some examples of the standard library code to use, etc. If you're familiar with that (or willing to spend time digging into that) then that would be great, but otherwise it may be better if I do it at some point 😃

@itsajay1029
Copy link

I am willing to dig deep and do it myself. If you can guide me on what resources I should use for learning more about it @yorickpeterse

@yorickpeterse
Copy link
Collaborator Author

@itsajay1029 Ehm, the resource is this very repository? Learning more would require digging into the runtime library, how it's used from the standard library, etc. Your best bet would be to read the existing documentation to learn more about Inko, then take a look at the standard library and the rest.

While the issue has the "accepting contributions" label, that doesn't necessarily mean everything is clearly laid out and no extra work is necessary, it just means I'm open to contributions from others. As such, unless you're willing to commit a decent amount of time now and in the future to Inko (otherwise it's just a waste to dig into it), it might be best to leave this issue be.

@yorickpeterse yorickpeterse self-assigned this Jun 13, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
accepting contributions Issues that are suitable to be worked on by anybody, not just maintainers documentation Documentation related changes
Projects
None yet
Development

No branches or pull requests

2 participants