Make field-subheadings as "<h2>" to make them a little easier to find.

This commit is contained in:
Mark Stosberg 2015-06-19 13:30:48 -04:00 committed by Trent Mick
parent 95fca4d805
commit 6103afadba

View file

@ -452,7 +452,7 @@ Pretty-printed:
} }
``` ```
Core fields: ## Core fields
- `v`: Required. Integer. Added by Bunyan. Cannot be overridden. - `v`: Required. Integer. Added by Bunyan. Cannot be overridden.
This is the Bunyan log format version (`require('bunyan').LOG_VERSION`). This is the Bunyan log format version (`require('bunyan').LOG_VERSION`).
@ -486,7 +486,7 @@ well. This is why we're using JSON. Some suggestions and best practices
follow (feedback from actual users welcome). follow (feedback from actual users welcome).
Recommended/Best Practice Fields: ## Recommended/Best Practice Fields
- `err`: Object. A caught JS exception. Log that thing with `log.info(err)` - `err`: Object. A caught JS exception. Log that thing with `log.info(err)`
to get: to get:
@ -539,7 +539,7 @@ Recommended/Best Practice Fields:
} }
``` ```
Other fields to consider: ## Other fields to consider
- `req.username`: Authenticated user (or for a 401, the user attempting to - `req.username`: Authenticated user (or for a 401, the user attempting to
auth). auth).