Skip to content

added return values to the Logger macro's documentation #4093

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Dec 20, 2015
Merged

added return values to the Logger macro's documentation #4093

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions lib/logger/lib/logger.ex
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -468,6 +468,8 @@ defmodule Logger do
@doc """
Logs a warning.

Returns the atom `:ok` or an `{:error, reason}` tuple.

## Examples

Logger.warn "knob turned too far to the right"
Expand All @@ -481,6 +483,8 @@ defmodule Logger do
@doc """
Logs some info.

Returns the atom `:ok` or an `{:error, reason}` tuple.

## Examples

Logger.info "mission accomplished"
Expand All @@ -494,6 +498,8 @@ defmodule Logger do
@doc """
Logs an error.

Returns the atom `:ok` or an `{:error, reason}` tuple.

## Examples

Logger.error "oops"
Expand All @@ -506,6 +512,8 @@ defmodule Logger do

@doc """
Logs a debug message.

Returns the atom `:ok` or an `{:error, reason}` tuple.

## Examples

Expand All @@ -519,6 +527,8 @@ defmodule Logger do

@doc """
Logs a message.

Returns the atom `:ok` or an `{:error, reason}` tuple.

Developers should use the macros `Logger.debug/2`,
`Logger.warn/2`, `Logger.info/2` or `Logger.error/2` instead
Expand Down