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 #205

Closed
petarvujovic98 opened this issue Sep 7, 2022 · 1 comment
Closed

Documentation #205

petarvujovic98 opened this issue Sep 7, 2022 · 1 comment
Assignees
Labels
DevEx documentation Improvements or additions to documentation v1.0

Comments

@petarvujovic98
Copy link
Contributor

petarvujovic98 commented Sep 7, 2022

Right now there are no JSDoc comments in the exposed API. This, along with better TypeScript type definitions, is key for DX as it speeds up workflows by making it so that developers don't have to go to the browser to have explanations about the functions and parameters they want to use/pass to those functions. IDEs are just going to show you the documentation on hover.

Also having more descriptive names for functions, parameters and generic parameters/types is a self documenting way of helping the developers have a lesser overhead when developing

@ailisp ailisp added documentation Improvements or additions to documentation DevEx labels Sep 13, 2022
@ailisp
Copy link
Member

ailisp commented Oct 11, 2022

Majority is addressed in #252, now only a few host functions (hashing, crypto primitives, etc.) are missing and JSDoc site generation

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
DevEx documentation Improvements or additions to documentation v1.0
Projects
None yet
Development

No branches or pull requests

2 participants