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.

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

wants to merge 1 commit into from

Conversation

Moelf
Copy link
Contributor

@Moelf Moelf commented Oct 2, 2020

close #23269

@dkarrasch dkarrasch added the docs This change adds or pertains to documentation label Oct 2, 2020
Copy link
Contributor

@kshyatt kshyatt left a comment

Choose a reason for hiding this comment

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

Might want to change phrasing but LGTM

base/set.jl Outdated Show resolved Hide resolved
@@ -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.

@ViralBShah ViralBShah closed this Nov 3, 2021
@Moelf Moelf deleted the set_itr_docs branch May 24, 2022 03:31
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs This change adds or pertains to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

State clearly in the documentation that the iteration of a Set occurs in undefined order
6 participants