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 jlapi #3111

Closed
ViralBShah opened this issue May 15, 2013 · 7 comments · Fixed by #5015
Closed

Document jlapi #3111

ViralBShah opened this issue May 15, 2013 · 7 comments · Fixed by #5015
Labels
docs This change adds or pertains to documentation help wanted Indicates that a maintainer wants help on an issue or pull request
Milestone

Comments

@ViralBShah
Copy link
Member

jlapi is likely to be of interest to many people. It should probably have a section in the manual.

@ViralBShah
Copy link
Member Author

Marking this as 0.2 milestone as we have people using this and trying this out. We can move it to a later version if that is what everyone thinks.

@Keno
Copy link
Member

Keno commented Aug 19, 2013

Not sure if we consider this stable enough yet. @JeffBezanson?

@Keno
Copy link
Member

Keno commented Aug 20, 2013

Bumping this to 0.3 as we don't feel this is mature enough yet. If people really want to use it, they can look at the code.

@tknopp
Copy link
Contributor

tknopp commented Nov 28, 2013

I am working on some documentation of the C API:

https://github.com/tknopp/julia/blob/docuCAPI/doc/manual/embedding.rst

This is at a really early stage. I would work on this in an iterative way:

  • Check how to achieve a specific embedding task
  • Improve/extend the C-API if necessary (e.g. export currently hidden symbols)
  • Write/improve the documentation

There are some things I am not yet familiar with. Dealing with the GC for instance. Would need some help in these areas.

Should I make a PR early to push this to master or wait until this is more complete?

@StefanKarpinski
Copy link
Member

Thanks for doing this. This was badly in need of documentation – I'm enjoying reading it. Very clear and nicely written!

@tknopp
Copy link
Contributor

tknopp commented Nov 30, 2013

Thanks, at some point some native speaker should revise this (I am one of the people that can provide you german git messages :-) ). But this can wait until it is a little bit more mature.

@ViralBShah
Copy link
Member Author

I think this should be a PR, as a chapter in the Julia manual. Of course, we also need to make the relevant symbols visible in libjulia, for which you have another PR.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs This change adds or pertains to documentation help wanted Indicates that a maintainer wants help on an issue or pull request
Projects
None yet
4 participants