From 4dde76231844faf79ef2c9bc457a47851d92875c Mon Sep 17 00:00:00 2001 From: Kevin Burke Date: Wed, 23 Mar 2016 22:10:40 -0700 Subject: [PATCH] Make the AuditLogger example show up in the docs `godoc` associates the docs with the function or type listed after the word "Example"; in this case "Errors" doesn't match anything in github.com/letsencrypt/boulder/log, so the example doesn't appear in the generated godoc. Changes the function name to ExampleAuditLogger so it shows up under the AuditLogger type. Here's a screenshot: https://monosnap.com/file/iXHqZHlnAjXnXPkAWUR5J1jMggOHLQ.png --- log/audit-logger_test.go | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/log/audit-logger_test.go b/log/audit-logger_test.go index 160afb49a..a583c0816 100644 --- a/log/audit-logger_test.go +++ b/log/audit-logger_test.go @@ -83,7 +83,7 @@ func TestEmitEmpty(t *testing.T) { log.AuditNotice("") } -func ExampleErrors() { +func ExampleAuditLogger() { audit := setup(nil) audit.clk = clock.NewFake()