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: Examples render teardown code #40517

Closed
deanishe opened this issue Jul 31, 2020 · 2 comments
Closed

x/pkgsite: Examples render teardown code #40517

deanishe opened this issue Jul 31, 2020 · 2 comments
Assignees
Milestone

Comments

@deanishe
Copy link

@deanishe deanishe commented Jul 31, 2020

What is the URL of the page with the issue?

https://pkg.go.dev/github.com/deanishe/awgo?tab=doc#example-Config.To

What is your user agent?

Firefox

Screenshot

go-pkg

godoc.org

godoc

What did you do?

Add teardown code to an example after the // Output: stanza.

What did you expect to see?

No teardown code (i.e. godoc.org behaviour).

What did you see instead?

Teardown code. As it's presented as part of the example body, and not after the test output as it actually appears in the source code, I believe it may confuse readers.

@gopherbot gopherbot added this to the Unreleased milestone Jul 31, 2020
@cagedmantis cagedmantis added the pkgsite label Jul 31, 2020
@cagedmantis
Copy link
Contributor

@cagedmantis cagedmantis commented Jul 31, 2020

/cc @julieqiu

@jba jba self-assigned this Aug 3, 2020
@gopherbot
Copy link

@gopherbot gopherbot commented Aug 3, 2020

Change https://golang.org/cl/246241 mentions this issue: internal/fetch/dochtml/internal/render: drop example cleanup code

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
4 participants
You can’t perform that action at this time.