Skip to content

Commit

Permalink
Unify package docs.
Browse files Browse the repository at this point in the history
  • Loading branch information
ChrisHines committed Jul 15, 2016
1 parent 02735ee commit ead1fe5
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 16 deletions.
24 changes: 18 additions & 6 deletions log/doc.go
Original file line number Diff line number Diff line change
@@ -1,9 +1,21 @@
// Package log provides a structured logger.
//
// Services produce logs to be consumed later, either by humans or machines.
// Humans might be interested in debugging errors, or tracing specific requests.
// Machines might be interested in counting interesting events, or aggregating
// information for offline processing. In both cases, it's important that the
// log messages be structured and actionable. Package log is designed to
// encourage both of these best practices.
// Applications may want to produce logs to be consumed later, either by
// humans or machines. Humans might be interested in debugging errors, or
// tracing specific requests. Machines might be interested in counting
// interesting events, or aggregating information for offline processing. In
// both cases, it's important that the log messages be structured and
// actionable. Package log is designed to encourage both of these best
// practices.
//
// Basic Usage
//
// The fundamental interface is Logger. Loggers create log events from
// key/value data.
//
// Concurrent Safety
//
// Applications with multiple goroutines want each log event written to the
// same logger to remain separate from other log events. Package log provides
// multiple solutions for concurrent safe logging.
package log
10 changes: 0 additions & 10 deletions log/log.go
Original file line number Diff line number Diff line change
@@ -1,13 +1,3 @@
// Package log provides basic interfaces for structured logging.
//
// The fundamental interface is Logger. Loggers create log events from
// key/value data.
//
// Concurrent Safety
//
// Applications with multiple goroutines want each log event written to the
// same logger to remain separate from other log events. Package log provides
// multiple solutions for concurrent safe logging.
package log

import "errors"
Expand Down

0 comments on commit ead1fe5

Please sign in to comment.