-
Notifications
You must be signed in to change notification settings - Fork 8
Add import comments #21
Add import comments #21
Conversation
parser/parser.go
Outdated
@@ -5,8 +5,8 @@ | |||
// License, v. 2.0. If a copy of the MPL was not distributed with this | |||
// file, You can obtain one at http://mozilla.org/MPL/2.0/. | |||
|
|||
// Package parser implements a parser for Gosh source files. | |||
package parser | |||
// package parser // import "gosh-lang.org/gosh/parser" implements a parser for Gosh source files. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
package comment should be of the form "Package parser ..."
scanner/scanner.go
Outdated
@@ -5,8 +5,8 @@ | |||
// License, v. 2.0. If a copy of the MPL was not distributed with this | |||
// file, You can obtain one at http://mozilla.org/MPL/2.0/. | |||
|
|||
// Package scanner implements a scanner for Gosh source text. | |||
package scanner | |||
// package scanner // import "gosh-lang.org/gosh/scanner" implements a scanner for Gosh source text. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
package comment should be of the form "Package scanner ..."
tokens/tokens.go
Outdated
@@ -5,8 +5,8 @@ | |||
// License, v. 2.0. If a copy of the MPL was not distributed with this | |||
// file, You can obtain one at http://mozilla.org/MPL/2.0/. | |||
|
|||
// Package tokens defines constants representing the lexical tokens of the Gosh programming language. | |||
package tokens | |||
// package tokens // import "gosh-lang.org/gosh/tokens" defines constants representing the lexical tokens of the Gosh programming language. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
package comment should be of the form "Package tokens ..."
parser/parser_test.go
Outdated
@@ -257,7 +257,7 @@ func TestParser(t *testing.T) { | |||
}) | |||
require.NoError(t, err) | |||
p := New(s, &Config{ | |||
// crashOnError: true, | |||
// crashOnError: true, |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
File is not goimports
-ed
Codecov Report
@@ Coverage Diff @@
## master #21 +/- ##
=======================================
Coverage 75.94% 75.94%
=======================================
Files 4 4
Lines 1002 1002
=======================================
Hits 761 761
Misses 209 209
Partials 32 32 Continue to review full report at Codecov.
|
#20 introduced exactly the same changes. 😄 |
Problem: Vanity import paths aren't mandatory
Solution: Add comments to enforce them. Closes #19