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

In-Code Documentation with TSDoc #39

Open
Hirschfuchs opened this issue Oct 10, 2023 · 1 comment
Open

In-Code Documentation with TSDoc #39

Hirschfuchs opened this issue Oct 10, 2023 · 1 comment

Comments

@Hirschfuchs
Copy link

As a developer, I would like to have an in-code-documentation, so that I can read the features and expected behaviours from within the IDE. I would strive for a gradual implementation, so that over the future development the documentation gets progressively better.

@roypeled
Copy link
Collaborator

I agree, we should try to add jsdoc annotations to the code, which most IDEs support. This will be a ongoing effort

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

2 participants