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/godoc-documenting-go-code.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/godoc-documenting-go-code.article')
| -rw-r--r-- | content/godoc-documenting-go-code.article | 2 |
1 files changed, 1 insertions, 1 deletions
diff --git a/content/godoc-documenting-go-code.article b/content/godoc-documenting-go-code.article index e75b105..26ff00a 100644 --- a/content/godoc-documenting-go-code.article +++ b/content/godoc-documenting-go-code.article @@ -1,7 +1,7 @@ # Godoc: documenting Go code 31 Mar 2011 Tags: godoc, technical -Summary: The Go project takes documentation seriously. Documentation is a huge part of making software accessible and maintainable. Of course it must be well-written and accurate, but it also must be easy to write and to maintain. Ideally, it should be coupled to the code itself so the documentation evolves along with the code. The easier it is for programmers to produce good documentation, the better for everyone. +Summary: How and why to document your Go packages. Andrew Gerrand |