Skip to content
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

Note Set is not ordered #37850

Closed
wants to merge 1 commit into from
Closed

Note Set is not ordered #37850

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
2 changes: 2 additions & 0 deletions base/set.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,8 @@ Set() = Set{Any}()
Construct a [`Set`](@ref) of the values generated by the given iterable object, or an
empty set. Should be used instead of [`BitSet`](@ref) for sparse integer sets, or
for sets of arbitrary objects.
!!! note
Iteration over `Set` is unordered.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would say that the iteration is ordered, but that the order is unspecified.

But seems like the bigger issue here is that we don't define what a "Set" is. I think the Dict docstring is a better model for the text here.

    Set([itr]) <: AbstractSet
 
Construct an unordered collection of unique values as a `Set`. Values are compared with [`isequal`](@ref) and hashed with [`hash`](@ref).

Given a single iterable argument, constructs a `Set` whose values are generated by the object.

This type should be used instead of [`BitSet`](@ref) for sparse integer sets, or
for sets of arbitrary objects.

"""
Set(itr) = _Set(itr, IteratorEltype(itr))

Expand Down