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

Update README.md #60

Closed
wants to merge 2 commits into from
Closed

Update README.md #60

wants to merge 2 commits into from

Conversation

komuw
Copy link

@komuw komuw commented Nov 16, 2018

add the correct canonical way of importing go modules that are greater than or equal to version 2

add the correct canonical way of importing go modules that are greater than or equal to version 2
adamdecaf
adamdecaf previously approved these changes Nov 16, 2018
@acln0
Copy link
Member

acln0 commented Nov 16, 2018

I'm not sure this is enough, in its current form. What about users of package uuid who don't use modules? We should at least leave a note, clarifying things.

@acln0 acln0 self-requested a review November 16, 2018 23:28
Copy link
Member

@acln0 acln0 left a comment

Choose a reason for hiding this comment

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

See my earlier comment. I don't think merging this as-is is right.

@niaow
Copy link
Member

niaow commented Nov 17, 2018

Maybe:

"github.com/gofrs/uuid"
// if using modules: "github.com/gofrs/uuid/v3"

@adamdecaf adamdecaf dismissed their stale review November 17, 2018 20:47

A comment makes more sense.

Copy link
Member

@theckman theckman left a comment

Choose a reason for hiding this comment

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

Thank you for this contribution. Would you please make this a comment above instead? I'm not totally sold on the phrasing I'm suggesting here, but here's the rough idea:

import (
	"log"

	// if using modules you may want github.com/gofrs/uuid/v3 instead
	"github.com/gofrs/uuid"
)

@codecov-io
Copy link

codecov-io commented Nov 18, 2018

Codecov Report

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

Impacted file tree graph

@@           Coverage Diff           @@
##           master      #60   +/-   ##
=======================================
  Coverage   98.92%   98.92%           
=======================================
  Files           4        4           
  Lines         279      279           
=======================================
  Hits          276      276           
  Misses          2        2           
  Partials        1        1

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 7077aa6...32057cf. Read the comment docs.

@acln0
Copy link
Member

acln0 commented Nov 20, 2018

Let's hold off on this until #61 is resolved. It seems tricky.

@theckman
Copy link
Member

We're about to merge a change to remove module support, which deprecates this PR. Thank you for the contribution and I'm sorry we weren't able to use it. We'll definitely resurrect something similar in the future depending on how modules shake out.

@theckman theckman closed this Jan 11, 2019
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.

6 participants