Repository navigation
docs: reattach doc comments to the declarations they describe - #12767
Open
clippytool wants to merge 1 commit into
Open
clippytool wants to merge 1 commit into
clippytool wants to merge 1 commit into
Conversation
Signed-off-by: clippytool <vetclippy@outlook.com>
Collaborator
|
@mudler Code-review sign-off at |
This branch has not been deployed
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.
Description
Two doc comments in the Go tree currently describe a declaration other than the one they
are attached to. Both were caused by the same mechanical mistake: a new declaration was
inserted between a comment and the declaration it documented, so the comment slid down
onto the newcomer.
core/config/distributed_config.go—ModelConfigResyncIntervalOrDefaultwas addedbetween the
StaleNodeThresholdOrDefaultcomment and its function (895d503, fix(distributed): converge model configs across frontends #12558).The comment block now opens with "StaleNodeThresholdOrDefault returns the configured
threshold or the default." above the resync interval accessor, and
StaleNodeThresholdOrDefaultitself has no doc comment at all.core/backend/video.go—VideoReferenceOptionswas added between theVideoGenerationOptionscomment and its type (e28d500, stablediffusion-ggml: run MiniMax-H3 video with references and add its gallery entries #12668). The two-line commentbeginning "VideoGenerationOptions is the backend-neutral request passed to video
generators" now documents
VideoReferenceOptions, whileVideoGenerationOptionsis leftwith no comment.
Both fixes only move comment lines back above the declaration they describe.
Notes for Reviewers
git diff -U0 | grep -v '^[+-]\s*//'is empty.gofmt -lreports nothing on either file.go buildwas not run to completion locally — the clone'spkg/grpc/proto/*.goare staleuntracked generated files (
undefined: pb.Generate3DRequestet al.) andprotocis notinstalled here. That failure predates this change and is unrelated to it.
declaration in the same file. Two more hits of the same class exist and are deliberately
left out of this PR to keep the scope tight:
core/http/endpoints/openai/transcription.go(the wholeTranscriptEndpointswaggerannotation block sits on
resolveTranscriptionLanguage, so swag attributes theannotations to the wrong function) and
core/services/distributed/gallery.go(
OperationProgressDetailscarriesUpdateProgress's comment). Happy to send thoseseparately.
Notes for Reviewers
Signed commits