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(jsdoc): ETag Middleware #2701

Merged

Conversation

goisaki
Copy link
Contributor

@goisaki goisaki commented May 18, 2024

This PR is to add JSDoc for ETag Middleware.
Note that the target of the PR is not main.

Related:

@goisaki
Copy link
Contributor Author

goisaki commented May 18, 2024

@yusukebe
Two problems there:

  • Description of options.retainedHeaders is not present in docs
  • options.weak is documented as adding w/, but the implementation is W/.

@goisaki goisaki mentioned this pull request May 18, 2024
16 tasks
@yusukebe
Copy link
Member

@goisaki

I'll work on it. Please wait a bit.

@yusukebe
Copy link
Member

Hi @goisaki

Description of options.retainedHeaders is not present in docs

I've added the description 061c570

options.weak is documented as adding w/, but the implementation is W/.

W/ is okay!

Copy link
Member

@yusukebe yusukebe left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!

@yusukebe yusukebe merged commit e390e22 into honojs:docs/jsdoc-middleware May 24, 2024
yusukebe added a commit that referenced this pull request May 24, 2024
* ETag Middleware

* add descriptio of `options.retainedHeaders`

---------

Co-authored-by: Yusuke Wada <yusuke@kamawada.com>
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