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

docs: Add TSDoc comments to improve code documentation and readability #2677

Closed
wants to merge 12 commits into from

Conversation

fzn0x
Copy link
Contributor

@fzn0x fzn0x commented May 15, 2024

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

  • Add tests
  • Run tests
  • bun denoify to generate files for Deno
  • bun run format:fix && bun run lint:fix to format the code

@fzn0x fzn0x marked this pull request as draft May 15, 2024 10:49
@fzn0x
Copy link
Contributor Author

fzn0x commented May 15, 2024

This will close #1338

@fzn0x
Copy link
Contributor Author

fzn0x commented May 15, 2024

https://hono.dev/api/request

TODO: add blob() and formData()

@fzn0x
Copy link
Contributor Author

fzn0x commented May 15, 2024

56f1e1f TSDoc comments are generally not as necessary in file that only contains modules export, but for completeness, it should be necessary

@yusukebe
Copy link
Member

@fzn0x

mod.ts, middleware.ts, and help.ts will be remove in #2662

@fzn0x
Copy link
Contributor Author

fzn0x commented May 15, 2024

Okay, lets skip those files @yusukebe

@fzn0x
Copy link
Contributor Author

fzn0x commented May 15, 2024

src/*.ts tsdoc is done, i will continue with src/adapter

@yusukebe yusukebe added the v4.4 label May 21, 2024
@yusukebe yusukebe changed the base branch from main to next May 22, 2024 20:37
@fzn0x
Copy link
Contributor Author

fzn0x commented May 23, 2024

I will continue this on weekend, have a lot of works recently, can't spend my time for open source make me sad

@yusukebe
Copy link
Member

Hi @fzn0x

I've merged other PRs to the next. I'll release the RC version for v4.4. And will release v4.4.0 in the next week.

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 v4.4.0.

And, we have to refer to the JSDoc format that @goisaki wrote in the PRs #2680.

@yusukebe
Copy link
Member

Hey @fzn0x

For now, shall we merge the current PR which added docs to src/*.ts?

@yusukebe
Copy link
Member

@fzn0x

I'll release v4.4.0 today. This PR is good, but it differs widely from the current next branch. So, after releasing v4.4.0, let's update and merge!

@fzn0x
Copy link
Contributor Author

fzn0x commented May 27, 2024

Hi @yusukebe sure, lets do it :)

@yusukebe yusukebe removed the v4.4 label May 27, 2024
@yusukebe yusukebe deleted the branch honojs:next May 27, 2024 07:31
@yusukebe yusukebe closed this May 27, 2024
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

Successfully merging this pull request may close these issues.

None yet

2 participants