From 1e0e65ea59205ef0b891b8672d66a7b92776ac88 Mon Sep 17 00:00:00 2001 From: David Symonds Date: Tue, 26 Mar 2013 13:01:24 +1100 Subject: [PATCH] doc/articles: update reference to obsolete "package documentation". R=golang-dev, r CC=golang-dev https://golang.org/cl/7475048 --- doc/articles/godoc_documenting_go_code.html | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) diff --git a/doc/articles/godoc_documenting_go_code.html b/doc/articles/godoc_documenting_go_code.html index 18a3ee9532..96ae7451d0 100644 --- a/doc/articles/godoc_documenting_go_code.html +++ b/doc/articles/godoc_documenting_go_code.html @@ -91,10 +91,9 @@ known issue from the bytes packa

-Godoc treats executable commands somewhat differently. Instead of inspecting the -command source code, it looks for a Go source file belonging to the special -package "documentation". The comment on the "package documentation" clause is -used as the command's documentation. For example, see the +Godoc treats executable commands in the same way. It looks for a comment on +package main, which is sometimes put in a separate file called doc.go. +For example, see the godoc documentation and its corresponding doc.go file.

-- 2.48.1