Skip to content

Commit c11d50e

Browse files
committed
Fixed doc typos in the Inspect protocol
1 parent 64e6037 commit c11d50e

File tree

1 file changed

+16
-16
lines changed

1 file changed

+16
-16
lines changed

lib/elixir/lib/inspect.ex

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -13,13 +13,13 @@ defprotocol Inspect do
1313
followed by the inspecting options, represented by the record
1414
`Inspect.Opts`.
1515
16-
Inspection is done by using the functions available in
16+
Inspection is done using the functions available in
1717
`Inspect.Algebra` and by calling `Kernel.inspect/2` recursively
18-
passing the `Inspect.Opts` as argument. When `Kernel.inspect/2`
19-
receives a `Inspect.Opts` record as second argument, it returns
18+
passing the `Inspect.Opts` as an argument. When `Kernel.inspect/2`
19+
receives an `Inspect.Opts` record as the second argument, it returns
2020
the underlying algebra document instead of the formatted string.
2121
22-
Many times, inspecting a structure can be implemented in function
22+
Many times, inspecting a structure can be implemented using functions
2323
of the existing entities. For example, here is `HashSet`'s `inspect`
2424
implementation:
2525
@@ -33,13 +33,13 @@ defprotocol Inspect do
3333
3434
The `concat` function comes from `Inspect.Algebra` and it
3535
concatenates algebra documents together. In the example above,
36-
it is concatenating the string `"HashSet<"` (all strings are a
37-
valid algebra document that keeps their formatting when pretty
36+
it is concatenating the string `"HashSet<"` (all strings are
37+
valid algebra documents that keep their formatting when pretty
3838
printed), the document returned by `Kernel.inspect/2` and the
3939
other string `">"`.
4040
41-
Since regular strings are a valid entity in an algebra document,
42-
an implementation of inspect may as well simply return a binary,
41+
Since regular strings are valid entities in an algebra document,
42+
an implementation of inspect may simply return a binary,
4343
although that will devoid it of any pretty-printing.
4444
"""
4545

@@ -50,8 +50,8 @@ defimpl Inspect, for: Atom do
5050
require Macro
5151

5252
@doc """
53-
Represents the atom as an Elixir term. The atoms false, true
54-
and nil are simply quoted. Modules are properly represented
53+
Represents the atom as an Elixir term. The atoms `false`, `true`
54+
and `nil` are simply quoted. Modules are properly represented
5555
as modules using the dot notation.
5656
5757
Notice that in Elixir, all operators can be represented using
@@ -193,7 +193,7 @@ end
193193

194194
defimpl Inspect, for: List do
195195
@doc %B"""
196-
Represents a list checking if it can be printed or not.
196+
Represents a list, checking if it can be printed or not.
197197
If so, a single-quoted representation is returned,
198198
otherwise the brackets syntax is used. Keywords are
199199
printed in keywords syntax.
@@ -249,7 +249,7 @@ end
249249

250250
defimpl Inspect, for: Tuple do
251251
@doc """
252-
Inspect tuples. If the tuple represents a record,
252+
Represents tuples. If the tuple represents a record,
253253
it shows it nicely formatted using the access syntax.
254254
255255
## Examples
@@ -316,10 +316,10 @@ defimpl Inspect, for: Number do
316316
@doc """
317317
Represents the number as a string.
318318
319-
Floats are represented using the shorted, correctly rounded string
319+
Floats are represented using the shortened, correctly rounded string
320320
that converts to float when read back with `binary_to_float/1`. This
321-
is done via the Erlang implementation of the "Printing Floating-Point
322-
Numbers Quickly and Accurately" in Proceedings of the SIGPLAN '96
321+
is done via the Erlang implementation of _Printing Floating-Point
322+
Numbers Quickly and Accurately_ in Proceedings of the SIGPLAN '96
323323
Conference on Programming Language Design and Implementation.
324324
325325
## Examples
@@ -338,7 +338,7 @@ defimpl Inspect, for: Number do
338338
end
339339

340340
defimpl Inspect, for: Regex do
341-
@moduledoc %B"""
341+
@doc %B"""
342342
Represents the Regex using the `%r""` syntax.
343343
344344
## Examples

0 commit comments

Comments
 (0)