diff options
| author | Russ Cox <rsc@golang.org> | 2020-03-14 09:44:01 -0400 |
|---|---|---|
| committer | Russ Cox <rsc@golang.org> | 2020-03-17 20:58:41 +0000 |
| commit | faf1e2da2d911edc717993e8edb24fe88f99b2b5 (patch) | |
| tree | 3b7d10f5f95b7bc9ca63d0591bd120b8d8f015b6 /content/examples.article | |
| parent | af5018f64e406aaa646dae066f28de57321ea5ce (diff) | |
content: write real summary for each article
The pre-Markdown blog invented a summary by copying
the first paragraph of text. Often this was nonsense or
at least useless.
The new Markdown-enabled present format adds an
explicit Summary line. The conversion populated these
with the same first paragraph that the old format would
have used implicitly.
This commit rewrites them all to be proper short summaries.
Change-Id: If2e1e101b95558d7ecd53c613f733a7f89c680f1
Reviewed-on: https://go-review.googlesource.com/c/blog/+/223598
Run-TryBot: Russ Cox <rsc@golang.org>
Reviewed-by: Andrew Bonventre <andybons@golang.org>
Diffstat (limited to 'content/examples.article')
| -rw-r--r-- | content/examples.article | 2 |
1 files changed, 1 insertions, 1 deletions
diff --git a/content/examples.article b/content/examples.article index 16614d3..86d727d 100644 --- a/content/examples.article +++ b/content/examples.article @@ -1,7 +1,7 @@ # Testable Examples in Go 7 May 2015 Tags: godoc, testing -Summary: Godoc [examples](https://golang.org/pkg/testing/#hdr-Examples) are snippets of Go code that are displayed as package documentation and that are verified by running them as tests. They can also be run by a user visiting the godoc web page for the package and clicking the associated "Run" button. +Summary: How to add examples, which double as tests, to your packages. Andrew Gerrand |