Skip to content

Commit 1211ed7

Browse files
committed
Document :history_size option
1 parent 2a08277 commit 1211ed7

File tree

1 file changed

+13
-0
lines changed

1 file changed

+13
-0
lines changed

lib/iex/lib/iex/options.ex

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,7 @@ defmodule IEx.Options do
3636
@supported_options [
3737
colors: [],
3838
inspect: [],
39+
history_size: [],
3940
]
4041

4142
@doc """
@@ -202,6 +203,18 @@ defmodule IEx.Options do
202203
"""
203204
def inspect
204205

206+
@doc """
207+
**NOTE**: This is just a stub for documentation purposes. Use
208+
`IEx.Options.get` and `IEx.Options.set` to query and change the option's
209+
value.
210+
211+
Number of expressions and their results to keep in the history.
212+
213+
The value is an integer. When it's less than 0, the history is unlimited.
214+
215+
"""
216+
def history_size
217+
205218
defp raise_option(name) do
206219
raise ArgumentError, message: "Unknown IEx option #{inspect name}"
207220
end

0 commit comments

Comments
 (0)