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.

Sign up for GitHub

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

Jump to bottom

Fix the comment style cause heading in pkgsite #1369

Merged
merged 1 commit into from
Sep 29, 2020
Merged

Fix the comment style cause heading in pkgsite #1369

merged 1 commit into from
Sep 29, 2020

Conversation

trongbq
Copy link
Contributor

@trongbq trongbq commented Sep 29, 2020

Overview

Fix the issue with comment heading in pkgsite: golang/go#41616

How

I wrote a simple Go program to detect these kind of comments. It showed following output:

1)File: cursormode.go:23
Comment: // Cursor Modes
2)File: examples/keyboard/keyboard/gen.go:262
Comment: // You may obtain a copy of the License at
3)File: gamepad.go:24
Comment: // GamepadButtons
4)File: genevents.go:309
Comment: // You may obtain a copy of the License at
5)File: genkeys.go:635
Comment: // You may obtain a copy of the License at
6)File: image.go:402
Comment: // DrawTrianglesShaderOptions represents options for DrawTrianglesShader
7)File: image.go:534
Comment: // DrawRectShaderOptions represents options for DrawRectShader
8)File: internal/graphicsdriver/opengl/gl/package_notwindows.go:729
Comment: // InitWithProcAddrFunc intializes the package using the specified OpenGL
9)File: internal/graphicsdriver/opengl/gl/package_windows.go:362
Comment: // InitWithProcAddrFunc intializes the package using the specified OpenGL
10)File: mousebuttons.go:24
Comment: // MouseButtons
11)File: run.go:369
Comment: // MonitorSize is an old name for ScreenSizeInFullscreen

After manually inspecting these 11 comments, there are 5 remaining comments need to be fixed: 6, 7, 8, 9, 11

hajimehoshi
hajimehoshi approved these changes Sep 29, 2020
View reviewed changes
Copy link
Owner

@hajimehoshi hajimehoshi left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, thanks!

@hajimehoshi hajimehoshi merged commit 0d29979 into hajimehoshi:master Sep 29, 2020
hajimehoshi pushed a commit that referenced this pull request Sep 29, 2020
@trongbq @hajimehoshi
Fix the comment style cause heading in pkgsite (#1369)
985ee12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@hajimehoshi hajimehoshi hajimehoshi approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@trongbq @hajimehoshi