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

testing: unordered examples are underdocumented #18840

Closed
ALTree opened this issue Jan 29, 2017 · 1 comment

Comments

Projects
None yet
2 participants
@ALTree
Copy link
Member

commented Jan 29, 2017

Unordered examples (9323de3) are documented in go doc cmd/go:

If the last comment begins with "Unordered output:" then the output is compared to the comment, however the order of the lines is ignored

but not in go doc testing (which is the actual place where people will look for Examples documentation).

$ go doc testing | grep -c Unordered
0

and for the same reason there's nothing on https://golang.org/pkg/testing/#hdr-Examples.

@ALTree ALTree added this to the Go1.9Maybe milestone Jan 29, 2017

@gopherbot

This comment has been minimized.

Copy link

commented Feb 25, 2017

CL https://golang.org/cl/37440 mentions this issue.

@gopherbot gopherbot closed this in 44bd39c Apr 10, 2017

lparth added a commit to lparth/go that referenced this issue Apr 13, 2017

testing: document example with unordered output
Copy the documentation and example from cmd/go.

Fixes golang#18840.

Change-Id: Id8022762b48576fb4031de05287d07a6ed23f480
Reviewed-on: https://go-review.googlesource.com/37440
Reviewed-by: Brad Fitzpatrick <bradfitz@golang.org>
Run-TryBot: Brad Fitzpatrick <bradfitz@golang.org>
TryBot-Result: Gobot Gobot <gobot@golang.org>

@golang golang locked and limited conversation to collaborators Apr 10, 2018

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
You can’t perform that action at this time.