aboutsummaryrefslogtreecommitdiffstats
path: root/ethlog/example_test.go
diff options
context:
space:
mode:
authorFelix Lange <fjl@twurst.com>2014-10-15 17:15:59 +0800
committerFelix Lange <fjl@twurst.com>2014-10-17 23:20:44 +0800
commit0165c1833017963a280f135a5733974a9fc3ec0b (patch)
treef639827843761216bf5daba09bf03eed26d0a268 /ethlog/example_test.go
parente0f93c74c54f04e8da18ee0f0eee58e322ddc89b (diff)
downloadgo-tangerine-0165c1833017963a280f135a5733974a9fc3ec0b.tar.gz
go-tangerine-0165c1833017963a280f135a5733974a9fc3ec0b.tar.zst
go-tangerine-0165c1833017963a280f135a5733974a9fc3ec0b.zip
ethlog: use Godoc for code examples in documentation
This ensures that examples will actually compile.
Diffstat (limited to 'ethlog/example_test.go')
-rw-r--r--ethlog/example_test.go21
1 files changed, 21 insertions, 0 deletions
diff --git a/ethlog/example_test.go b/ethlog/example_test.go
new file mode 100644
index 000000000..2532f36c1
--- /dev/null
+++ b/ethlog/example_test.go
@@ -0,0 +1,21 @@
+package ethlog
+
+import "os"
+
+func ExampleLogger() {
+ logger := NewLogger("TAG")
+ logger.Infoln("so awesome") // prints [TAG] so awesome
+ logger.Infof("this %q is raw", "coin") // prints [TAG] this "coin" is raw
+}
+
+func ExampleLogSystem() {
+ filename := "test.log"
+ file, _ := os.OpenFile(filename, os.O_RDWR|os.O_CREATE, os.ModePerm)
+ fileLog := NewStdLogSystem(file, 0, WarnLevel)
+ AddLogSystem(fileLog)
+
+ stdoutLog := NewStdLogSystem(os.Stdout, 0, WarnLevel)
+ AddLogSystem(stdoutLog)
+
+ NewLogger("TAG").Warnln("reactor meltdown") // writes to both logs
+}