Skip to content

Add @doc false to Inspect.Algebra.no_limit/1 #13893

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 3 commits into from
Oct 10, 2024
Merged

Add @doc false to Inspect.Algebra.no_limit/1 #13893

Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
f347425
Add @doc false to Inspect.Algebra.no_limit/1
sabiwara Oct 9, 2024
856c9d3
Document Inspect.Algebra.no_limit/1
sabiwara Oct 10, 2024
0825ba7
Update lib/elixir/lib/inspect/algebra.ex
sabiwara Oct 10, 2024
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
15 changes: 15 additions & 0 deletions lib/elixir/lib/inspect/algebra.ex
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -588,6 +588,21 @@ defmodule Inspect.Algebra do
doc_cons(doc1, doc2)
end

@doc ~S"""
Prevents breaks inside the document.

## Examples

iex> doc = Inspect.Algebra.glue("hello", "world") |> Inspect.Algebra.group()
iex> Inspect.Algebra.format(doc, 10)
["hello", "\n", "world"]
iex> doc = Inspect.Algebra.no_limit(doc)
iex> Inspect.Algebra.format(doc, 10)
["hello", " ", "world"]

"""
@doc since: "1.14.0"
@spec no_limit(t) :: t
def no_limit(doc) do
doc_limit(doc, :infinity)
end
Expand Down
Loading