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

A bit more detailed documentation needed #35

Open
mr-j0nes opened this issue Jun 27, 2017 · 2 comments
Open

A bit more detailed documentation needed #35

mr-j0nes opened this issue Jun 27, 2017 · 2 comments

Comments

@mr-j0nes
Copy link
Collaborator

I know you guys are focused on bringing more features to the lib, but it would be good to provide a bit better documentation and examples (I sent another post about this), so the ones willing to use the current version can fully understand what they can do with it..

E.g.

  • I am not sure how to use signals, I can see raft::fileread uses raft::eof, but not sure what is done with it.
  • I don't see any documentation for the method send()
  • not sure how to use allocate() with e.g. int
  • How to know what are the built-in out-of-the-box kernels ? e.g. raft:fileread, raft:.print, etc..
  • ...
@jonathan-beard
Copy link
Member

That I definitely agree with. Partially it'll come once more people start leaving feedback (as you just did), the rest is finding the appropriate wording to efficiently explain everything. I'll get to work on what you described above, please list any more that you have. Feel free to update the wiki yourself as you find errors, I've had a few other uses do so as well. Often things that seem obvious to me are very much so not obvious to others.

Thanks for the comments, I'll hold off on closing till I've added documentation for the above items.

@jonathan-beard
Copy link
Member

Will work on this one tomorrow....documentation definitely needs work. At least we have some docs :). Thanks @mr-j0nes

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants