Skip to content

Commit 8530694

Browse files
committed
Move the list of inspect options back to Kernel's docstring
1 parent a916cf4 commit 8530694

File tree

2 files changed

+11
-14
lines changed

2 files changed

+11
-14
lines changed

lib/elixir/lib/kernel.ex

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1890,7 +1890,13 @@ defmodule Kernel do
18901890
18911891
## Options
18921892
1893-
See the docs for IEx.Options for more details.
1893+
The following options are supported:
1894+
1895+
* raw -- when true, record tuples are not formatted by the inspect protocol,
1896+
but are printed as just tuples; default: false
1897+
1898+
* limit -- limits the number of items that are printed for tuples, bitstrings,
1899+
and lists; does not apply to strings
18941900
18951901
## Examples
18961902

lib/iex/lib/iex/options.ex

Lines changed: 4 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ defmodule IEx.Options do
77
88
If the value of an option is a keyword list, only those keys that are
99
mentioned will be changed. The rest of the sub-options will keep their
10-
current values.
10+
current values. Any extraneous keys are filtered out, i.e. not used.
1111
1212
To get the list of all supported options, use `list/0`. You can also get an
1313
option's description using `print_help/1`.
@@ -39,9 +39,6 @@ defmodule IEx.Options do
3939
This is an aggregate option that encapsulates all color settings used
4040
by the shell.
4141
42-
The value is a keyword list that should have any of the following keys
43-
specified. If any of the keys is omitted, that color is not changed.
44-
4542
* enabled -- boolean value that allows for switching the coloring
4643
on and off
4744
@@ -56,16 +53,10 @@ defmodule IEx.Options do
5653
inspect: [
5754
doc: """
5855
Control the behavior of the shell's inspecting algorithm. Inspect is
59-
used for printing results of evaluating expressions. It is also used by IO.inspect.
60-
61-
The value is a keyword list that should have any of the following keys
62-
specified. If any of the keys is omitted, that option is not changed.
63-
64-
* raw -- when true, record tuples are not formatted by the inspect protocol,
65-
but are printed as just tuples; default: false
56+
used for printing results of evaluating expressions. It is also used by
57+
IO.inspect.
6658
67-
* limit -- limits the number of items that are printed for tuples, bitstrings,
68-
and lists; does not apply to strings
59+
See the doc for `Kernel.inspect/2` for the full list of options.
6960
7061
"""
7162
],

0 commit comments

Comments
 (0)