JuliaCollections / JuliaCollections/DataStructures.jl
OrderedSet construction doc error
Nobody has claimed this yet.
- Dominant language
- Julia
- Stars
- 745
- Forks
- 261
- PR merge metrics
- No merged PRs in 30d
Description
Hello,
In doc, an example to construct an OrderedSet is given
https://github.com/JuliaCollections/DataStructures.jl/blame/c31f17f0d0dead44ae7766b36fd880dcae666a9d/doc/src/ordered_containers.md#L16
but it doesn't work as expected
julia> s = OrderedSet(π,e,γ,catalan,φ)
ERROR: MethodError: no method matching DataStructures.OrderedSet(::Irrational{:π}, ::Irrational{:e}, ::Irrational{:γ}, ::Irrational{:catalan}, ::Irrational{:φ})
Closest candidates are:
DataStructures.OrderedSet(::Any) at C:\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\Users\scls\AppData\Local\JuliaPro-0.6.2.1\pkgs-0.6.2.1\v0.6\DataStructures\src\ordered_set.jl:15
Kind regards
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Read the example in doc/src/ordered_containers.md at the linked line and compare it with the OrderedSet constructor in src/ordered_set.jl. Confirm the documented Julia expression produces the reported MethodError, then update the example so it uses a supported construction and verify it runs successfully.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- julia
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 55/100