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 MIT license for pkg.go.dev; tidy go.mod and create go.sum #62

Merged
merged 1 commit into from
Dec 31, 2019

Conversation

myitcv
Copy link
Contributor

@myitcv myitcv commented Dec 31, 2019

Currently the documentation for github.com/kr/pretty is not displayed on
pkg.go.dev because of license restrictions:

https://pkg.go.dev/github.com/kr/pretty?tab=doc

This is almost certainly because the License file includes an errant
header:

The MIT License (MIT)

The actual MIT license does not include this header:

https://opensource.org/licenses/MIT

GitHub and other interfaces surface the type of the license through
automatic detection (as will pkg.go.dev). Hence this header is
superfluous in any case.

Whilst we are at it, tidy up go.mod and add go.sum.

Currently the documentation for github.com/kr/pretty is not displayed on
pkg.go.dev because of license restrictions:

    https://pkg.go.dev/github.com/kr/pretty?tab=doc

This is almost certainly because the License file includes an errant
header:

    The MIT License (MIT)

The actual MIT license does not include this header:

    https://opensource.org/licenses/MIT

GitHub and other interfaces surface the type of the license through
automatic detection (as will pkg.go.dev). Hence this header is
superfluous in any case.

Whilst we are at it, tidy up go.mod and add go.sum.
@kr kr merged commit 4e08863 into kr:main Dec 31, 2019
@kr
Copy link
Owner

kr commented Dec 31, 2019

Sweet, thanks!

@myitcv
Copy link
Contributor Author

myitcv commented Jan 1, 2020

Thanks. You're going to need to cut a new version for pkg.go.dev to see the changes

@dmitshur
Copy link

dmitshur commented Feb 1, 2020

This is almost certainly because the License file includes an errant
header:

The MIT License (MIT)

As a data point, this LICENSE file gets recognized as the MIT license (see https://pkg.go.dev/github.com/shurcooL/httpfs?tab=licenses), but its header is a shorter "MIT License" text from https://choosealicense.com/licenses/mit/.

hbt added a commit to hbt/pretty that referenced this pull request Jul 16, 2020
* origin/main:
  wip
  init fork
  Fix MIT license for pkg.go.dev; tidy go.mod and create go.sum (kr#62)
  fix ineffectual assignment of showTypeInStruct (kr#61)
  fix typo in Println description (kr#60)
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