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

Jump to bottom

No documentation for Base.Order and Ordering for sort and search functions #18370

Closed
andyferris opened this issue Sep 6, 2016 · 0 comments · Fixed by #36886
Closed

No documentation for Base.Order and Ordering for sort and search functions #18370

andyferris opened this issue Sep 6, 2016 · 0 comments · Fixed by #36886
Labels
docs This change adds or pertains to documentation help wanted Indicates that a maintainer wants help on an issue or pull request needs docs Documentation for this change is required

Comments

@andyferris
Copy link
Member

Julia 0.5-rc3 contains new methods for searchsortedfirst() and many other functions that involve specifying the sort pattern using singleton types defined in Base.Order. This is really awesome, and I like it a lot, but the users should probably be able to find out about this in the documentation and docstrings.

At the very least, I feel that a NEWS.md entry should be added before tagging v0.5 final, so that new v0.5 users may know about these changes. It certainly surprised me in #18369 :)
@tkelman tkelman added needs docs Documentation for this change is required needs news A NEWS entry is required for this change labels Sep 6, 2016
@tkelman tkelman modified the milestones: 0.5.0, 0.5.x Sep 6, 2016
@andyferris andyferris mentioned this issue Sep 7, 2016
Closed
@StefanKarpinski StefanKarpinski added help wanted Indicates that a maintainer wants help on an issue or pull request and removed help wanted Indicates that a maintainer wants help on an issue or pull request labels Oct 27, 2016
@JeffBezanson JeffBezanson added docs This change adds or pertains to documentation and removed needs news A NEWS entry is required for this change labels May 21, 2018
@JeffBezanson JeffBezanson removed this from the 0.5.x milestone May 21, 2018
@jlumpe jlumpe mentioned this issue Aug 3, 2020
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
docs This change adds or pertains to documentation help wanted Indicates that a maintainer wants help on an issue or pull request needs docs Documentation for this change is required
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Add documentation for Base.Order module jlumpe/julia
4 participants
@StefanKarpinski @JeffBezanson @andyferris @tkelman