docs(config/legacy): fix truncated struct comments in LocalSvrConf - #5484
Open
zhaoxinyi02 wants to merge 1 commit into
Open
docs(config/legacy): fix truncated struct comments in LocalSvrConf#5484zhaoxinyi02 wants to merge 1 commit into
zhaoxinyi02 wants to merge 1 commit into
Conversation
The legacy LocalSvrConf doc comments were corrupted by an over-broad
word replacement, producing fragments like 'will to', 'to to', and
'for ng'. Restore the intended wording, matching the v1 ProxyBackend
comments ('of the backend', 'handling connections'), and fix the
field reference LocalIp -> LocalIP to match the actual field name.
Co-Authored-By: AtomCode (GLM-5.2) <noreply@atomgit.com>
Contributor
There was a problem hiding this comment.
Pull request overview
Fixes corrupted legacy godoc comments on LocalSvrConf so they read correctly again and render properly in documentation.
Changes:
- Restored intended wording in
LocalSvrConfand its fields (LocalIP,LocalPort) to remove truncated/duplicated fragments. - Clarified the
Pluginfield comment and corrected the field reference toLocalIPso godoc links to the actual identifier.
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
Code Review SummaryStatus: No Issues Found | Recommendation: Merge Files Reviewed (1 files)
Reviewed by gpt-5.6-sol · Input: 27 · Output: 3.5K · Cached: 165.5K |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
WHY
The legacy
LocalSvrConfstruct doc comments were corrupted by an over-broad word replacement, producing fragments that no longer read as English:LocalSvrConf configures what location the client will to→ missing verb (will to)LocalIP specifies the IP address or host name to to→ duplicatedtoLocalPort specifies the port to to→ duplicatedtoPlugin specifies what plugin should be used for ng→ truncated (for ng)These are the only occurrences of such corruption in
pkg/config/legacy; the rest of the file is intact, so this looks like a localized bad find/replace rather than a systemic issue.WHAT
Restore the intended wording, matching the equivalent v1 comments in
pkg/config/v1/proxy.go(ProxyBackend):will forward toof the backend(for bothLocalIPandLocalPort)for handling connectionsAlso fix the field reference
LocalIp→LocalIPto match the actual Go field name, so godoc renders the reference correctly.Pure doc/comment change; no code or behavior touched.