JuliaCollections / JuliaCollections/DataStructures.jl
Confused about docs
Nobody has claimed this yet.
- Dominant language
- Julia
- Stars
- 745
- Forks
- 261
- PR merge metrics
- No merged PRs in 30d
Description
Eh, I'm finding it very hard to work out what methods are implemented for what in what release thanks to all this churn.
Pkg finds the current release at 0.18.15 for me, which uses dequeue! for PriorityQueue and does not implement popfirst! - at least, I am shouted at for trying to use it.
The documentation, however, merrily tells me that I should definitely use popfirst! , despite (again), this not being implemented in the release that Pkg thinks is most recent.
If this isn't implemented in an actually released version, can the documentation at least not claim this works when it doesn't yet?
Originally posted by @aoanla in https://github.com/JuliaCollections/DataStructures.jl/issues/845#issuecomment-1859153774
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
Start by comparing the PriorityQueue documentation's guidance for popfirst! with the API available in released version 0.18.15, where the issue reports dequeue! is required. Done means the documentation accurately reflects the released version or clearly identifies the version in which popfirst! becomes available.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- julia
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100