Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix function godoc comment #3502

Merged
merged 1 commit into from
Feb 14, 2024
Merged

Conversation

dmitris
Copy link
Contributor

@dmitris dmitris commented Feb 14, 2024

PR fixes an error in the function comment. See https://go.dev/doc/comment regarding the documentation standards for the Go code comments.

The Goland IDE says about the current version:

Comment should have the following format 'MakeTimeoutNotification ...' (with an optional leading article) 
 Inspection info: Reports comments that do not start with the name of the exported element.
According to Comment Sentences at github.com/golang, this is a convention to begin a comment with the name of the exported element.
Example:
// represents a request to run a command.
type Request struct {}
The comment starts with the struct description, not with the struct name. To stick to the convention rules, you can apply the Add prefix to comment quick-fix. After the quick-fix is applied, the comment looks as follows:
// Request represents a request to run a command.
type Request struct {} // better

@bsardo bsardo self-requested a review February 14, 2024 18:41
@bsardo bsardo changed the title fix function godoc comment Fix function godoc comment Feb 14, 2024
@bsardo bsardo merged commit 2b10083 into prebid:master Feb 14, 2024
3 checks passed
@dmitris dmitris deleted the godoc-adapters-bidder branch February 15, 2024 12:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants