Skip to content

Commit

Permalink
Clarify handling of message argument.
Browse files Browse the repository at this point in the history
[ci skip]
  • Loading branch information
maleadt committed Apr 9, 2018
1 parent 94a1d78 commit 40c230c
Showing 1 changed file with 4 additions and 2 deletions.
6 changes: 4 additions & 2 deletions stdlib/Logging/docs/src/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -65,8 +65,10 @@ automatically extracted. Let's examine the user-defined data first:
- Use `Error` to report errors where the code has enough context to recover
and continue. (When the code doesn't have enough context, an exception or
early return is more appropriate.)
* The *message* is a human readable string describing the event in markdown
format.
* The *message* is an object describing the event. By convention
`AbstractString`s passed as messages are assumed to be in markdown format.
Other types will be displayed using `show(io,mime,obj)` according to the
display capabilities of the installed logger.
* Optional *key--value pairs* allow arbitrary data to be attached to each event.
Some keys have conventional meaning that can affect the way an event is
interpreted (see [`@logmsg`](@ref)).
Expand Down

0 comments on commit 40c230c

Please sign in to comment.