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

x/pkgsite: test files with build errors should not inhibit documentation #48590

Open
bcmills opened this issue Sep 23, 2021 · 0 comments
Open

x/pkgsite: test files with build errors should not inhibit documentation #48590

bcmills opened this issue Sep 23, 2021 · 0 comments

Comments

@bcmills
Copy link
Member

@bcmills bcmills commented Sep 23, 2021

What is the URL of the page with the issue?

https://pkg.go.dev/github.com/bcmills/more@v0.0.0-20210923162553-f9db90522ad1

What is your user agent?

N/A

Screenshot

image

What did you do?

Commit a package with a _test.go source file that fails to type-check with the current Go release (Go 1.17).

What did you expect to see?

Documentation for the package API, since a broken test file doesn't prevent downstream users from building or using the exported API.

(And, even if the non-test the package can't be analyzed at all due to a build error, I would rather see an entry in the Directories listing with a description of that build error, rather than silently dropping the package from the listing!)

What did you see instead?

No documentation is shown at all for the directory with the bad test file.
(https://github.com/bcmills/more/blob/f9db90522ad116a76b5b750ac7094f01ba5d220d/morebytes/file_fuzz_test.go)

@gopherbot gopherbot added this to the Unreleased milestone Sep 23, 2021
@jamalc jamalc removed this from the Unreleased milestone Oct 4, 2021
@jamalc jamalc added this to the pkgsite/unplanned milestone Oct 4, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Linked pull requests

Successfully merging a pull request may close this issue.

None yet
3 participants