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

Documentation of full API #47

Open
Nettsentrisk opened this issue Mar 1, 2017 · 3 comments
Open

Documentation of full API #47

Nettsentrisk opened this issue Mar 1, 2017 · 3 comments
Labels
documentation Not a bug, but behaviour needs better documentation

Comments

@Nettsentrisk
Copy link

Are there plans to document the API?

  • addTranslation
  • setRenderer
  • etc.
@Boldewyn
Copy link
Contributor

Boldewyn commented Mar 1, 2017

Plans, yes. Time, no 😢. The idea is to replace the "High-Level API" document with a more structured approach: Which configuration parameters are possible, which methods do hyperform and the wrapper hyperform(window) expose, and so on.

Thanks for the ticket! I'll try to make time to get this thing out of the door soon. It's clear to me, that a library is mostly only as good as its documentation.

@Boldewyn
Copy link
Contributor

Boldewyn commented Mar 1, 2017

Note to self: Don't forget to document the hooks infrastructure.

@Nettsentrisk
Copy link
Author

Would also love to see an example of how to use hyperform with a validation rule that is dependent on an AJAX request.

@Boldewyn Boldewyn added the documentation Not a bug, but behaviour needs better documentation label Mar 26, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Not a bug, but behaviour needs better documentation
Projects
None yet
Development

No branches or pull requests

2 participants