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

Source code documentation #72

Open
Ryuno-Ki opened this issue Feb 16, 2023 · 1 comment
Open

Source code documentation #72

Ryuno-Ki opened this issue Feb 16, 2023 · 1 comment
Labels
enhancement New feature or request

Comments

@Ryuno-Ki
Copy link

As you can tell I'm a fan of adding JSDoc comments to source code to help understanding a codebase.

If you are open to it, I'm going to open PRs against this project.

Do you want me to document the signature as well? (Types of arguments and return values)

@nhoizey
Copy link
Contributor

nhoizey commented Feb 18, 2023

@Ryuno-Ki everything that helps maintain the project is welcome, making the code more easy to understand is part of this, so your PRs would be welcome, thanks! 🙏

@nhoizey nhoizey added the enhancement New feature or request label Feb 18, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants