Clean up godoc comments (#3613)

Author: pkwarren

private/buf/bufcli/cache.go

@@ -281,7 +281,7 @@ func newPluginDataProvider(
 	if err != nil {
 		return nil, err
 	}
-	delegateModuleDataProvider := bufpluginapi.NewPluingDataProvider(
+	delegateModuleDataProvider := bufpluginapi.NewPluginDataProvider(
 		container.Logger(),
 		pluginClientProvider,
 	)

private/buf/bufcli/flags_args.go

@@ -179,7 +179,7 @@ func BindArchiveStatus(flagSet *pflag.FlagSet, addr *string, flagName string) {
 	)
 }
 
-// Binds a string pointer flag, which indicates flag presence, i.e. `--flag ""` is not the same as not passing the flag.
+// BindStringPointer binds a string pointer flag, which indicates flag presence, i.e. `--flag ""` is not the same as not passing the flag.
 //
 // This is useful for buf registry organization/module update, where we only modify the fields specified.
 //

private/buf/buffetch/buffetch.go

@@ -71,7 +71,7 @@ var (
 	//
 	// This does not include deprecated formats.
 	SourceOrModuleFormatsString = stringutil.SliceToString(sourceOrModuleFormatsNotDeprecated)
-	// DirOrProtoFileFormats is the string representation of all dir or proto file formats.
+	// DirOrProtoFileFormatsString is the string representation of all dir or proto file formats.
 	//
 	// This does not include deprecated formats.
 	DirOrProtoFileFormatsString = stringutil.SliceToString(dirOrProtoFileFormats)
@@ -146,7 +146,7 @@ type ProtoFileRef interface {
 	SourceRef
 	DirOrProtoFileRef
 	ProtoFilePath() string
-	// True if the FileScheme is Stdio, Stdout, Stdin, or Null.
+	// IsDevPath returns true if the FileScheme is Stdio, Stdout, Stdin, or Null.
 	IsDevPath() bool
 	IncludePackageFiles() bool
 	internalProtoFileRef() internal.ProtoFileRef
@@ -167,7 +167,7 @@ type MessageRefParser interface {
 type SourceRefParser interface {
 	// GetSourceRef gets the reference for the source file.
 	GetSourceRef(ctx context.Context, value string) (SourceRef, error)
-	// GetSourceRef gets the reference for the source file.
+	// GetSourceRefForInputConfig gets the reference for the source file.
 	GetSourceRefForInputConfig(
 		ctx context.Context,
 		inputConfig bufconfig.InputConfig,
@@ -233,8 +233,8 @@ type RefParser interface {
 	DirRefParser
 	SourceOrModuleRefParser
 
-	// TODO FUTURE: should this be renamed to GetRefForString?
 	// GetRef gets the reference for the message file, source bucket, or module.
+	// TODO FUTURE: should this be renamed to GetRefForString?
 	GetRef(ctx context.Context, value string) (Ref, error)
 	// GetRefForInputConfig gets the reference for the message file, source bucket, or module.
 	GetRefForInputConfig(ctx context.Context, inputConfig bufconfig.InputConfig) (Ref, error)
@@ -328,7 +328,7 @@ type SourceReader interface {
 // GetReadBucketCloserOption is an option for a GetSourceReadBucketCloser call.
 type GetReadBucketCloserOption func(*getReadBucketCloserOptions)
 
-// GetReadBucketCloserCopyToInMemory says to copy the returned ReadBucketCloser to an
+// GetReadBucketCloserWithCopyToInMemory says to copy the returned ReadBucketCloser to an
 // in-memory ReadBucketCloser. This can be a performance optimization at the expense of memory.
 func GetReadBucketCloserWithCopyToInMemory() GetReadBucketCloserOption {
 	return func(getReadBucketCloserOptions *getReadBucketCloserOptions) {

private/buf/buffetch/internal/internal.go

@@ -511,7 +511,7 @@ type ProtoFileWriter interface {
 	) (io.WriteCloser, error)
 }
 
-// NewProtoWriter returns a new ProtoWriter.
+// NewProtoFileWriter returns a new ProtoFileWriter.
 func NewProtoFileWriter(
 	logger *slog.Logger,
 ) ProtoFileWriter {
@@ -820,7 +820,7 @@ func WithGetFileKeepFileCompression() GetFileOption {
 // GetReadBucketCloserOption is a GetReadBucketCloser option.
 type GetReadBucketCloserOption func(*getReadBucketCloserOptions)
 
-// WithGetBucketCopyToInMemory says to copy the returned ReadBucketCloser to an
+// WithGetReadBucketCloserCopyToInMemory says to copy the returned ReadBucketCloser to an
 // in-memory ReadBucket. This can be a performance optimization at the expense of memory.
 func WithGetReadBucketCloserCopyToInMemory() GetReadBucketCloserOption {
 	return func(getReadBucketCloserOptions *getReadBucketCloserOptions) {

private/buf/buflsp/file.go

@@ -175,7 +175,7 @@ func (f *file) Update(ctx context.Context, version int32, text string) {
 	f.hasText = true
 }
 
-// FetchSettings refreshes configuration settings for this file.
+// RefreshSettings refreshes configuration settings for this file.
 //
 // This only needs to happen when the file is open or when the client signals
 // that configuration settings have changed.

private/buf/buflsp/report.go

@@ -37,7 +37,7 @@ func (r *report) Error(err reporter.ErrorWithPos) error {
 	return nil
 }
 
-// Error implements reporter.Handler for *diagnostics.
+// Warning implements reporter.Handler for *diagnostics.
 func (r *report) Warning(err reporter.ErrorWithPos) {
 	r.diagnostics = append(r.diagnostics, newDiagnostic(err, true))
 

private/buf/buflsp/server.go

@@ -216,7 +216,7 @@ func (s *server) DidOpen(
 	return nil
 }
 
-// DidOpen is called whenever the client opens a document. This is our signal to parse
+// DidChange is called whenever the client opens a document. This is our signal to parse
 // the file.
 func (s *server) DidChange(
 	ctx context.Context,
@@ -320,8 +320,7 @@ func (s *server) Formatting(
 	}, nil
 }
 
-// DidOpen is called whenever the client opens a document. This is our signal to parse
-// the file.
+// DidClose is called whenever the client closes a document.
 func (s *server) DidClose(
 	ctx context.Context,
 	params *protocol.DidCloseTextDocumentParams,
@@ -332,7 +331,7 @@ func (s *server) DidClose(
 
 // -- Language functionality methods.
 
-// Definition is the entry point for hover inlays.
+// Hover is the entry point for hover inlays.
 func (s *server) Hover(
 	ctx context.Context,
 	params *protocol.HoverParams,

private/buf/buflsp/symbol.go

@@ -149,7 +149,7 @@ func (s *symbol) ReferencePath() (path []string, absolute bool) {
 	return
 }
 
-// Resolve attempts to resolve an unresolved reference across fileManager.
+// ResolveCrossFile attempts to resolve an unresolved reference across fileManager.
 func (s *symbol) ResolveCrossFile(ctx context.Context) {
 	switch kind := s.kind.(type) {
 	case *definition:

private/buf/bufworkspace/option.go

@@ -29,7 +29,7 @@ type WorkspaceModuleKeyOption interface {
 	applyToWorkspaceModuleKeyConfig(*workspaceModuleKeyConfig)
 }
 
-// WorkspaceOption is an option for a new Workspace created by either a Bucket or ModuleKey.
+// WorkspaceBucketAndModuleKeyOption is an option for a new Workspace created by either a Bucket or ModuleKey.
 type WorkspaceBucketAndModuleKeyOption interface {
 	WorkspaceBucketOption
 	WorkspaceModuleKeyOption
@@ -89,7 +89,7 @@ func WithTargetPaths(targetPaths []string, targetExcludePaths []string) Workspac
 // This flag will only work if no buf.work.yaml is detected, and the buf.yaml is a v1beta1
 // buf.yaml, v1 buf.yaml, or no buf.yaml. This flag will not work if a buf.work.yaml is
 // detected, or a v2 buf.yaml is detected.
-
+//
 // If used with NewWorkspaceForModuleKey, this has no effect on the build,
 // i.e. excludes are not respected, and the module name is ignored. This matches old behavior.
 //

private/buf/bufworkspace/workspace_dep_manager_provider.go

@@ -25,7 +25,7 @@ import (
 
 // WorkspaceDepManagerProvider provides WorkspaceDepManagers.
 type WorkspaceDepManagerProvider interface {
-	// GetWorkspaceDepManagerForBucket returns a new WorkspaceDepManager for the given Bucket.
+	// GetWorkspaceDepManager returns a new WorkspaceDepManager for the given Bucket.
 	//
 	// If the workspace is not updateable, an error is returned.
 	//
@@ -34,7 +34,7 @@ type WorkspaceDepManagerProvider interface {
 	//
 	// Otherwise, this builds a Workspace with a single module at the TargetSubDirPath (which may be "."), ignoring buf.work.yamls.
 	// Directories with buf.work.yamls cannot be directly targeted.
-
+	//
 	// Note this is the same logic as if WithIgnoreAndDisallowV1BufWorkYAMLs is applied with WorkspaceProvider!! If you want an equivalent
 	// Workspace, you need to use this option!
 	//