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 implementation details on the Javascript client #7

Open
plcp opened this issue Nov 13, 2018 · 0 comments
Open

Document implementation details on the Javascript client #7

plcp opened this issue Nov 13, 2018 · 0 comments

Comments

@plcp
Copy link
Collaborator

plcp commented Nov 13, 2018

Few details have been given in answer of 5e29d15 and should be integrated with the documentation of the library – as GitHub comments are not a practical way of documenting the library in a long-term, resilient fashion.

This is especially interesting as most of the library have been designed to have all of its parts at least configurable and for the most part completely replaceable by a custom implementation of the appropriate handler – this will be useful only if people can hack into it with well-documented behaviors.

TL;DR: Giving more insights on the implementation details of the client will enable fellow power-users and researchers to hack their way through the code.

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

No branches or pull requests

1 participant