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 API documentation #8

Open
kristiank opened this issue Jun 26, 2021 · 2 comments
Open

Add API documentation #8

kristiank opened this issue Jun 26, 2021 · 2 comments
Labels
documentation Improvements or additions to documentation

Comments

@kristiank
Copy link

Before using this, Ifirst say that this is a great thing to have. Now to the question. I am confused what documentation applies for using the PGF JSON inside my javascript. Should I follow the Haskell or C runtime documentation I find on grammaticalframework.org?

@kristiank
Copy link
Author

I'll try to pinpoint my issue. Is it possible and if, then how can I interface the incremental parsing ability in the javascript PGF?

@johnjcamilleri
Copy link
Member

Hi @kristiank, there is no actual documentation apart from the library itself. You're right though, that it should exist.

To answer your question directly, you can use incremental parsing with the function GFConcrete.complete()

@johnjcamilleri johnjcamilleri changed the title What API documentation applies? Add API documentation Jun 28, 2021
@johnjcamilleri johnjcamilleri added the documentation Improvements or additions to documentation label Jun 28, 2021
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
Projects
None yet
Development

No branches or pull requests

2 participants