Skip to content
This repository has been archived by the owner on Jan 15, 2023. It is now read-only.

Add import comments #21

Closed
wants to merge 3 commits into from
Closed

Add import comments #21

wants to merge 3 commits into from

Conversation

mmiranda96
Copy link
Contributor

@mmiranda96 mmiranda96 commented Oct 1, 2018

Problem: Vanity import paths aren't mandatory

Solution: Add comments to enforce them. Closes #19

@mmiranda96 mmiranda96 requested a review from AlekSi as a code owner October 1, 2018 23:58
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.

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 ..."

@@ -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.

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.

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 ..."

@@ -257,7 +257,7 @@ func TestParser(t *testing.T) {
})
require.NoError(t, err)
p := New(s, &Config{
// crashOnError: true,
// crashOnError: true,

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
Copy link

codecov bot commented Oct 2, 2018

Codecov Report

Merging #21 into master will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           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.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 2485a10...44f0cbe. Read the comment docs.

@AlekSi
Copy link
Member

AlekSi commented Oct 2, 2018

#20 introduced exactly the same changes. 😄

@AlekSi AlekSi closed this Oct 2, 2018
@AlekSi
Copy link
Member

AlekSi commented Oct 2, 2018

Other simple issues you may work on are #23 and #15 (macOS part).

@mmiranda96 mmiranda96 deleted the feature/enforce_vanity_import_paths branch October 2, 2018 13:26
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants