Skip to content

Clarify the return value and indexing of List.pop_at/3 #16082

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
josevalim merged 1 commit into from
Nov 8, 2026
+8 −3
Merged

Clarify the return value and indexing of List.pop_at/3 #16082

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
11 changes: 8 additions & 3 deletions lib/elixir/lib/list.ex
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -936,10 +936,15 @@ defmodule List do
end

@doc """
Returns and removes the value at the specified `index` in the `list`.
Removes the element at `index` from `list`.
Returns `{value, updated_list}`, where `value` is the
removed element and `updated_list` is the remaining list.

Negative indices indicate an offset from the end of the `list`.
If `index` is out of bounds, the original `list` is returned.
Indices start at `0`. Negative indices count from the
end of the list. Index `-1` selects the last element.

If `index` is out of bounds, returns `{default, list}`,
where `default` is `nil` unless specified.

## Examples

Expand Down