Skip to content

Commit e1941a7

Browse files
wojtekmachjosevalim
authored andcommitted
Minor docs updates (#7123)
1 parent c4113cd commit e1941a7

File tree

4 files changed

+18
-18
lines changed

4 files changed

+18
-18
lines changed

lib/elixir/lib/kernel.ex

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3819,7 +3819,7 @@ defmodule Kernel do
38193819
38203820
## rescue/catch/after
38213821
3822-
Function bodies support `rescue`, `catch` and `after` as `SpecialForms.try/1`
3822+
Function bodies support `rescue`, `catch` and `after` as `Kernel.SpecialForms.try/1`
38233823
does. The following two functions are equivalent:
38243824
38253825
def format(value) do

lib/elixir/lib/kernel/special_forms.ex

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ defmodule Kernel.SpecialForms do
44
cannot be overridden by the developer.
55
66
We define them in this module. Some of these forms are lexical (like
7-
`alias/2`, `case/2`, etc). The macros `{}` and `<<>>` are also special
7+
`alias/2`, `case/2`, etc). The macros `{}/1` and `<<>>/1` are also special
88
forms used to define tuple and binary data structures respectively.
99
1010
This module also documents macros that return information about Elixir's

lib/elixir/pages/Compatibility and Deprecations.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -73,7 +73,7 @@ Deprecated feature | Deprecated in | Replaced by (
7373
`()` to mean `nil` | [v1.5] | `nil` (v1.0)
7474
`:as_char_lists` value in `t:Inspect.Opts.t/0` type | [v1.5] | `:as_charlists` (v1.3)
7575
`:char_lists` key in `t:Inspect.Opts.t/0` type | [v1.5] | `:charlists` (v1.3)
76-
`char_list/0` type | [v1.5] | `charlist/0` type (v1.3)
76+
`char_list/0` type | [v1.5] | `t:charlist/0` type (v1.3)
7777
`@compile {:parse_transform, _}` in `Module` | [v1.5] | *None*
7878
EEx: `<%=` in middle and end expressions | [v1.5] | Use `<%` (= is allowed only on start expressions) (v1.0)
7979
`Access.key/1` | [v1.4] | `Access.key/2` (v1.3)

lib/logger/lib/logger.ex

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -16,8 +16,8 @@ defmodule Logger do
1616
performant when required but also apply backpressure
1717
when under stress.
1818
19-
* Wraps OTP's `error_logger` to prevent it from
20-
overflowing.
19+
* Wraps OTP's [`:error_logger`](http://erlang.org/doc/man/error_logger.html)
20+
to prevent it from overflowing.
2121
2222
Logging is useful for tracking when an event of interest happens in your
2323
system. For example, it may be helpful to log whenever a user is deleted.
@@ -63,7 +63,7 @@ defmodule Logger do
6363
application is started, but may be changed during runtime
6464
6565
* Error logger configuration - configuration for the
66-
wrapper around OTP's `error_logger`
66+
wrapper around OTP's [`:error_logger`](http://erlang.org/doc/man/error_logger.html)
6767
6868
### Application configuration
6969
@@ -145,11 +145,11 @@ defmodule Logger do
145145
### Error logger configuration
146146
147147
The following configuration applies to `Logger`'s wrapper around
148-
Erlang's `error_logger`. All the configurations below must be set
149-
before the `:logger` application starts.
148+
OTP's [`:error_logger`](http://erlang.org/doc/man/error_logger.html).
149+
All the configurations below must be set before the `:logger` application starts.
150150
151151
* `:handle_otp_reports` - redirects OTP reports to `Logger` so
152-
they are formatted in Elixir terms. This uninstalls Erlang's
152+
they are formatted in Elixir terms. This uninstalls OTP's
153153
logger that prints terms to terminal. Defaults to `true`.
154154
155155
* `:handle_sasl_reports` - redirects supervisor, crash and
@@ -163,17 +163,17 @@ defmodule Logger do
163163
reached, triggers the error logger to discard messages. This
164164
value must be a positive number that represents the maximum
165165
number of messages accepted per second. Once above this
166-
threshold, the `error_logger` enters discard mode for the
167-
remainder of that second. Defaults to 500 messages.
166+
threshold, the [`:error_logger`](http://erlang.org/doc/man/error_logger.html)
167+
enters discard mode for the remainder of that second. Defaults to 500 messages.
168168
169-
For example, to configure `Logger` to redirect all `error_logger` messages
170-
using a `config/config.exs` file:
169+
For example, to configure `Logger` to redirect all [`:error_logger`](http://erlang.org/doc/man/error_logger.html)
170+
messages using a `config/config.exs` file:
171171
172172
config :logger,
173173
handle_otp_reports: true,
174174
handle_sasl_reports: true
175175
176-
Furthermore, `Logger` allows messages sent by Erlang's `error_logger`
176+
Furthermore, `Logger` allows messages sent by OTP's [`:error_logger`](http://erlang.org/doc/man/error_logger.html)
177177
to be translated into an Elixir format via translators. Translators
178178
can be dynamically added at any time with the `add_translator/1`
179179
and `remove_translator/1` APIs. Check `Logger.Translator` for more
@@ -521,8 +521,8 @@ defmodule Logger do
521521
## Options
522522
523523
* `:flush` - when `true`, guarantees all messages currently sent
524-
to both Logger and Erlang's `error_logger` are processed before
525-
the backend is added
524+
to both Logger and OTP's [`:error_logger`](http://erlang.org/doc/man/error_logger.html)
525+
are processed before the backend is added
526526
527527
"""
528528
@spec add_backend(atom, keyword) :: Supervisor.on_start_child()
@@ -548,8 +548,8 @@ defmodule Logger do
548548
## Options
549549
550550
* `:flush` - when `true`, guarantees all messages currently sent
551-
to both Logger and Erlang's `error_logger` are processed before
552-
the backend is removed
551+
to both Logger and OTP's [`:error_logger`](http://erlang.org/doc/man/error_logger.html)
552+
are processed before the backend is removed
553553
554554
"""
555555
@spec remove_backend(atom, keyword) :: :ok | {:error, term}

0 commit comments

Comments
 (0)