Improve the documentation of logRequests().
Closes #57
R=srawlins@google.com
Review URL: https://codereview.chromium.org//2281723002 .
diff --git a/CHANGELOG.md b/CHANGELOG.md
index 4747e5f..1e541a5 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -1,3 +1,7 @@
+## 0.6.5+3
+
+* Improve the documentation of `logRequests()`.
+
## 0.6.5+2
* Support `http_parser` 3.0.0.
diff --git a/lib/src/handlers/logger.dart b/lib/src/handlers/logger.dart
index 9f76f6c..98866d5 100644
--- a/lib/src/handlers/logger.dart
+++ b/lib/src/handlers/logger.dart
@@ -12,15 +12,13 @@
/// Middleware which prints the time of the request, the elapsed time for the
/// inner handlers, the response's status code and the request URI.
///
-/// [logger] takes two parameters.
+/// If [logger] is passed, it's called for each request. The `msg` parameter is
+/// a formatted string that includes the request time, duration, request method,
+/// and requested path. When an exception is thrown, it also includes the
+/// exception's string and stack trace; otherwise, it includes the status code.
+/// The `isError` parameter indicates whether the message is caused by an error.
///
-/// `msg` includes the request time, duration, request method, and requested
-/// path.
-///
-/// For successful requests, `msg` also includes the status code.
-///
-/// When an error is thrown, `isError` is true and `msg` contains the error
-/// description and stack trace.
+/// If [logger] is not passed, the message is just passed to [print].
Middleware logRequests({void logger(String msg, bool isError)}) =>
(innerHandler) {
if (logger == null) logger = _defaultLogger;
diff --git a/pubspec.yaml b/pubspec.yaml
index 59edd5a..2376077 100644
--- a/pubspec.yaml
+++ b/pubspec.yaml
@@ -1,5 +1,5 @@
name: shelf
-version: 0.6.5+2
+version: 0.6.5+3
author: Dart Team <misc@dartlang.org>
description: Web Server Middleware for Dart
homepage: https://github.com/dart-lang/shelf
