Repository navigation
Let GitHub name the license, show the error examples on pkg.go.dev - #11
Merged
Merged
Conversation
GitHub showed the license as "Other": LICENSE held the Go authors' notice below the BSD 3-Clause text, so the file matched no known license. The notice now has its own file, NOTICE, and LICENSE holds the BSD 3-Clause text alone. ExampleErrInvalidDuration and ExampleErrWrongType were named after variables, and go/doc attaches examples only to the package, functions, types and methods. pkg.go.dev therefore showed 13 of the 15 examples. They are package examples now: Example_invalidDuration and Example_wrongType.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Two things a first-time visitor sees wrongly today.
The license shows as "Other"
LICENSEheld the Go authors' notice below the BSD 3-Clause text, so GitHub matched the file to no knownlicense and its API reports
NOASSERTION. Scorecard's License check sits at 9 for the same reason.LICENSEnow holds the BSD 3-Clause text alone.NOTICE.decimal.go,digits.goandiso8601.goand the README point toNOTICE.pkg.go.dev already detected BSD-3-Clause and is not affected.
Two examples are missing on pkg.go.dev
ExampleErrInvalidDurationandExampleErrWrongTypewere named after variables.go/docattaches examplesonly to the package, functions, types and methods, so pkg.go.dev showed 13 of the 15 examples and left out
the two about handling errors.
They are package examples now,
Example_invalidDurationandExample_wrongType. Listing the examplesthrough
go/docshows 15 of 15 on this branch.Checks
just checkpasses. On this branch, GitHub's license API reportsBSD-3-ClauseforLICENSE; on main itreports
NOASSERTION.