-
-
Notifications
You must be signed in to change notification settings - Fork 436
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
docs: Add TSDoc comments to improve code documentation and readability #2677
Conversation
This will close #1338 |
TODO: add |
56f1e1f TSDoc comments are generally not as necessary in file that only contains modules export, but for completeness, it should be necessary |
Okay, lets skip those files @yusukebe |
|
I will continue this on weekend, have a lot of works recently, can't spend my time for open source make me sad |
Hi @fzn0x I've merged other PRs to the I'd like to use the documents you wrote in this PR, but you don't need to hurry. It can be merged after releasing the And, we have to refer to the JSDoc format that @goisaki wrote in the PRs #2680. |
Hey @fzn0x For now, shall we merge the current PR which added docs to |
I'll release |
Hi @yusukebe sure, lets do it :) |
This PR will takes a long time, I wouldn't finish it in a day.
But this is a good start, anyone can contribute in my repository https://github.com/fzn0x/hono/tree/fzn0x/tsdoc
The author should do the following, if applicable
bun denoify
to generate files for Denobun run format:fix && bun run lint:fix
to format the code