Skip to content

docs(hertz): fix outdated doc of hertz server config#1408

Merged
GuangmingLuo merged 2 commits intocloudwego:mainfrom
gaspardruan:patch-2
Sep 8, 2025
Merged

docs(hertz): fix outdated doc of hertz server config#1408
GuangmingLuo merged 2 commits intocloudwego:mainfrom
gaspardruan:patch-2

Conversation

@gaspardruan
Copy link
Copy Markdown
Contributor

What type of PR is this?

docs: Documentation only changes

Check the PR title.

  • This PR title match the format: <type>(optional scope): <description>
  • The description of this PR title is user-oriented and clear enough for others to understand.

The doc said WithReadBufferSize could limit the header size, but the code comments said not. And the code was modified(2025) after the documentation was submitted(2023). So I think it's good to update the WithReadBufferSize doc according the new code comments.

// WithReadBufferSize sets the size of each read buffer node in standard transport.
// NOTE: this cannot limit the header size.
func WithReadBufferSize(size int) config.Option {
	return config.Option{F: func(o *config.Options) {
		o.ReadBufferSize = size
	}}
}

@gaspardruan gaspardruan requested review from a team as code owners September 5, 2025 14:57
@netlify
Copy link
Copy Markdown

netlify Bot commented Sep 5, 2025

Deploy Preview for cloudwego ready!

Name Link
🔨 Latest commit 3da3895
🔍 Latest deploy log https://app.netlify.com/projects/cloudwego/deploys/68bafa701b2999000855baba
😎 Deploy Preview https://deploy-preview-1408--cloudwego.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@GuangmingLuo GuangmingLuo merged commit 5252c1d into cloudwego:main Sep 8, 2025
4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Development

Successfully merging this pull request may close these issues.

2 participants