testing: test example missing from beginning of package doc #27839
Labels
Documentation
Issues describing a change to documentation.
FrozenDueToAge
NeedsInvestigation
Someone must examine and confirm this is a valid issue and not a duplicate of an existing one.
Milestone
Comments
|
Change https://golang.org/cl/137175 mentions this issue: |
|
Screenshots from the CL ☝️ The example in the beginning section of the overview:
The existing skipping example moved to a later section:
|
andybons
added
NeedsInvestigation
bradfitz
pushed a commit
that referenced
this issue
Nov 21, 2018
The package doc for the testing package doesn't have a simple example demonstrating how to write a test with an expectation. The doc has simple examples for benchmarks, examples, and skipping, and it would be useful for people new to writing tests in Go. Also moved the skip example further down because it references tests and benchmarks but benchmarks haven't been discussed in detail until the next section. Skip is also a less used feature and it seems misplaced to sit so high up in the package documentation. As an example, Skip is used 570 times the Go code repository which is significantly less than Error and Fatal that are used 23,303 times. Also changed 'sample' to 'simple' in other places in the package documentation to keep the language used consistent when describing the small examples. Fixes #27839 Change-Id: Ie01a3751986ee61adf2a2f2eda59cc182342baa7 GitHub-Last-Rev: 7357bfd GitHub-Pull-Request: #27840 Reviewed-on: https://go-review.googlesource.com/c/137175 Run-TryBot: Brad Fitzpatrick <bradfitz@golang.org> TryBot-Result: Gobot Gobot <gobot@golang.org> Reviewed-by: Brad Fitzpatrick <bradfitz@golang.org> Reviewed-by: Emmanuel Odeke <emm.odeke@gmail.com>
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
What version of Go are you using (
go version)?go version go1.11What did you do?
I went to the testing package documentation to find an example to share with another person.
What did you expect to see?
I expected to be see a simple few line example demonstrating how to write a test function and how to write an expectation.
What did you see instead?
Full examples for benchmarks, and example tests, and even an example of how to skip a test, but no examples of how to write a test with a simple expectation.
CL
I can open a small CL adding an example to the package documentation unless anyone feels like that'd be a bad idea.
The text was updated successfully, but these errors were encountered: