pkg: fix function names in comment (#2761)

Signed-off-by: mountcount <cuimoman@outlook.com>
This commit is contained in:
mountcount 2024-04-30 00:21:26 +08:00 committed by GitHub
parent 0df300c0ca
commit 1d92655d97
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
4 changed files with 5 additions and 5 deletions

View file

@ -169,7 +169,7 @@ func AddLogger(parent context.Context) Context {
return WithLogger(parent, defaultLogger) return WithLogger(parent, defaultLogger)
} }
// SetupDefaultLogger sets the package-level global default logger that will be // SetDefaultLogger sets the package-level global default logger that will be
// used for Background and TODO contexts. On startup, the default logger will // used for Background and TODO contexts. On startup, the default logger will
// be configured to output logs to stderr. Use logr.Discard() to disable all // be configured to output logs to stderr. Use logr.Discard() to disable all
// logs from Contexts. // logs from Contexts.

View file

@ -43,7 +43,7 @@ func init() {
filter = builder.Build() filter = builder.Build()
} }
// IsKnownFalsePositives will not return a valid secret finding if any of the disqualifying conditions are met // IsKnownFalsePositive will not return a valid secret finding if any of the disqualifying conditions are met
// Currently that includes: No number, english word in key, or matches common example pattens. // Currently that includes: No number, english word in key, or matches common example pattens.
// Only the secret key material should be passed into this function // Only the secret key material should be passed into this function
func IsKnownFalsePositive(match string, falsePositives []FalsePositive, wordCheck bool) bool { func IsKnownFalsePositive(match string, falsePositives []FalsePositive, wordCheck bool) bool {

View file

@ -12,7 +12,7 @@ import (
"github.com/trufflesecurity/trufflehog/v3/pkg/sources/postman" "github.com/trufflesecurity/trufflehog/v3/pkg/sources/postman"
) )
// ScanGitHub scans Postman with the provided options. // ScanPostman scans Postman with the provided options.
func (e *Engine) ScanPostman(ctx context.Context, c sources.PostmanConfig) error { func (e *Engine) ScanPostman(ctx context.Context, c sources.PostmanConfig) error {
connection := sourcespb.Postman{ connection := sourcespb.Postman{
Workspaces: c.Workspaces, Workspaces: c.Workspaces,

View file

@ -307,13 +307,13 @@ func (jp *JobProgress) Ref() JobProgressRef {
} }
} }
// EnumerationErrors joins all errors encountered during initialization or // EnumerationError joins all errors encountered during initialization or
// enumeration. // enumeration.
func (m JobProgressMetrics) EnumerationError() error { func (m JobProgressMetrics) EnumerationError() error {
return errors.Join(m.Errors...) return errors.Join(m.Errors...)
} }
// ChunkErrors joins all errors encountered during chunking. // ChunkError joins all errors encountered during chunking.
func (m JobProgressMetrics) ChunkError() error { func (m JobProgressMetrics) ChunkError() error {
var aggregate []error var aggregate []error
for _, err := range m.Errors { for _, err := range m.Errors {