diff --git a/docs/api.md b/docs/api.md index f09e9fcf5..ea7c7bc26 100644 --- a/docs/api.md +++ b/docs/api.md @@ -141,7 +141,7 @@ If an object is supplied, three options can be specified: #### `formatters` (Object) -An object containing functions for formatting the shape of the logs. +An object containing functions for formatting the shape of the log lines. These functions should return an JSONifiable object and they should never throw. You can use this functions to shape the final JSON log in the way you need. For example you can use it for changing the level key name or enrich the default bindings.